diff --git a/bin/ansible/roles/atlassian.crowd/templates/docker-compose/template.docker-compose.jdk17.j2 b/bin/ansible/roles/atlassian.crowd/templates/docker-compose/template.docker-compose.jdk17.yml.j2 similarity index 100% rename from bin/ansible/roles/atlassian.crowd/templates/docker-compose/template.docker-compose.jdk17.j2 rename to bin/ansible/roles/atlassian.crowd/templates/docker-compose/template.docker-compose.jdk17.yml.j2 diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.1/.env b/linux/ecosystem/atlassian/crowd/0/0.3.1/.env new file mode 100644 index 000000000..67b9004ba --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.1/.env @@ -0,0 +1,3 @@ +RELEASE=0.3.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.zip +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.zip diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.1/Dockerfile b/linux/ecosystem/atlassian/crowd/0/0.3.1/Dockerfile new file mode 100644 index 000000000..dee55a99c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.1/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=0.3.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-0.3.1.zip +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-0.3.1.zip + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + 7zz x ${TEMP_ARCHIVE} -o/tmp/crowd-temp && \ + mv /tmp/crowd-temp/*/* "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ +# sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ +# sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.1/Makefile b/linux/ecosystem/atlassian/crowd/0/0.3.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.1/README.md b/linux/ecosystem/atlassian/crowd/0/0.3.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/0/0.3.1/docker-compose.yml new file mode 100644 index 000000000..ef1f2b335 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.1/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:0.3.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:0.3.1-jdk6" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/0/0.3.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.2/.env b/linux/ecosystem/atlassian/crowd/0/0.3.2/.env new file mode 100644 index 000000000..159af5c27 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.2/.env @@ -0,0 +1,3 @@ +RELEASE=0.3.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.zip +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.zip diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.2/Dockerfile b/linux/ecosystem/atlassian/crowd/0/0.3.2/Dockerfile new file mode 100644 index 000000000..5d34d21b7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=0.3.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-0.3.2.zip +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-0.3.2.zip + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + 7zz x ${TEMP_ARCHIVE} -o/tmp/crowd-temp && \ + mv /tmp/crowd-temp/*/* "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ +# sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ +# sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.2/Makefile b/linux/ecosystem/atlassian/crowd/0/0.3.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.2/README.md b/linux/ecosystem/atlassian/crowd/0/0.3.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/0/0.3.2/docker-compose.yml new file mode 100644 index 000000000..7bb07009e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.2/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:0.3.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:0.3.2-jdk6" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/0/0.3.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.3/.env b/linux/ecosystem/atlassian/crowd/0/0.3.3/.env new file mode 100644 index 000000000..a20707358 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.3/.env @@ -0,0 +1,3 @@ +RELEASE=0.3.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.zip +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.zip diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.3/Dockerfile b/linux/ecosystem/atlassian/crowd/0/0.3.3/Dockerfile new file mode 100644 index 000000000..dfabb82f3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.3/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=0.3.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-0.3.3.zip +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-0.3.3.zip + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + 7zz x ${TEMP_ARCHIVE} -o/tmp/crowd-temp && \ + mv /tmp/crowd-temp/*/* "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ +# sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ +# sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.3/Makefile b/linux/ecosystem/atlassian/crowd/0/0.3.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.3/README.md b/linux/ecosystem/atlassian/crowd/0/0.3.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/0/0.3.3/docker-compose.yml new file mode 100644 index 000000000..58bf2beee --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.3/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:0.3.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:0.3.3-jdk6" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/0/0.3.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/0/0.3.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.3.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.1/.env b/linux/ecosystem/atlassian/crowd/0/0.4.1/.env new file mode 100644 index 000000000..ee0240dad --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.1/.env @@ -0,0 +1,3 @@ +RELEASE=0.4.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/crowd-${RELEASE}-std.zip +TEMP_ARCHIVE=/tmp/crowd-${RELEASE}-std.zip diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.1/Dockerfile b/linux/ecosystem/atlassian/crowd/0/0.4.1/Dockerfile new file mode 100644 index 000000000..49509b82a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.1/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=0.4.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/crowd-0.4.1-std.zip +ARG TEMP_ARCHIVE=/tmp/crowd-0.4.1-std.zip + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + 7zz x ${TEMP_ARCHIVE} -o/tmp/crowd-temp && \ + mv /tmp/crowd-temp/*/* "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ +# sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ +# sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.1/Makefile b/linux/ecosystem/atlassian/crowd/0/0.4.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.1/README.md b/linux/ecosystem/atlassian/crowd/0/0.4.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/0/0.4.1/docker-compose.yml new file mode 100644 index 000000000..714e4c865 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.1/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:0.4.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:0.4.1-jdk6" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/0/0.4.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.2/.env b/linux/ecosystem/atlassian/crowd/0/0.4.2/.env new file mode 100644 index 000000000..e10e037a9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.2/.env @@ -0,0 +1,3 @@ +RELEASE=0.4.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/crowd-${RELEASE}-std.zip +TEMP_ARCHIVE=/tmp/crowd-${RELEASE}-std.zip diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.2/Dockerfile b/linux/ecosystem/atlassian/crowd/0/0.4.2/Dockerfile new file mode 100644 index 000000000..f0d6abe00 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=0.4.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/crowd-0.4.2-std.zip +ARG TEMP_ARCHIVE=/tmp/crowd-0.4.2-std.zip + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + 7zz x ${TEMP_ARCHIVE} -o/tmp/crowd-temp && \ + mv /tmp/crowd-temp/*/* "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ +# sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ +# sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.2/Makefile b/linux/ecosystem/atlassian/crowd/0/0.4.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.2/README.md b/linux/ecosystem/atlassian/crowd/0/0.4.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/0/0.4.2/docker-compose.yml new file mode 100644 index 000000000..30d3c19dc --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.2/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:0.4.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:0.4.2-jdk6" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/0/0.4.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.3/.env b/linux/ecosystem/atlassian/crowd/0/0.4.3/.env new file mode 100644 index 000000000..0829742b7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.3/.env @@ -0,0 +1,3 @@ +RELEASE=0.4.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/crowd-${RELEASE}-std.zip +TEMP_ARCHIVE=/tmp/crowd-${RELEASE}-std.zip diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.3/Dockerfile b/linux/ecosystem/atlassian/crowd/0/0.4.3/Dockerfile new file mode 100644 index 000000000..e17c7cfc7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.3/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=0.4.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/crowd-0.4.3-std.zip +ARG TEMP_ARCHIVE=/tmp/crowd-0.4.3-std.zip + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + 7zz x ${TEMP_ARCHIVE} -o/tmp/crowd-temp && \ + mv /tmp/crowd-temp/*/* "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ +# sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ +# sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.3/Makefile b/linux/ecosystem/atlassian/crowd/0/0.4.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.3/README.md b/linux/ecosystem/atlassian/crowd/0/0.4.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/0/0.4.3/docker-compose.yml new file mode 100644 index 000000000..5cc18e05c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.3/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:0.4.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:0.4.3-jdk6" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/0/0.4.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.4/.env b/linux/ecosystem/atlassian/crowd/0/0.4.4/.env new file mode 100644 index 000000000..1877c6b31 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.4/.env @@ -0,0 +1,3 @@ +RELEASE=0.4.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/crowd-${RELEASE}-std.zip +TEMP_ARCHIVE=/tmp/crowd-${RELEASE}-std.zip diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.4/Dockerfile b/linux/ecosystem/atlassian/crowd/0/0.4.4/Dockerfile new file mode 100644 index 000000000..e1d7a7d0b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.4/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=0.4.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/crowd-0.4.4-std.zip +ARG TEMP_ARCHIVE=/tmp/crowd-0.4.4-std.zip + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + 7zz x ${TEMP_ARCHIVE} -o/tmp/crowd-temp && \ + mv /tmp/crowd-temp/*/* "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ +# sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ +# sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.4/Makefile b/linux/ecosystem/atlassian/crowd/0/0.4.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.4/README.md b/linux/ecosystem/atlassian/crowd/0/0.4.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/0/0.4.4/docker-compose.yml new file mode 100644 index 000000000..dab788c5c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.4/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:0.4.4" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:0.4.4-jdk6" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/0/0.4.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.5/.env b/linux/ecosystem/atlassian/crowd/0/0.4.5/.env new file mode 100644 index 000000000..61f0bc92d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.5/.env @@ -0,0 +1,3 @@ +RELEASE=0.4.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/crowd-${RELEASE}-std.zip +TEMP_ARCHIVE=/tmp/crowd-${RELEASE}-std.zip diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.5/Dockerfile b/linux/ecosystem/atlassian/crowd/0/0.4.5/Dockerfile new file mode 100644 index 000000000..9984c080c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.5/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=0.4.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/crowd-0.4.5-std.zip +ARG TEMP_ARCHIVE=/tmp/crowd-0.4.5-std.zip + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + 7zz x ${TEMP_ARCHIVE} -o/tmp/crowd-temp && \ + mv /tmp/crowd-temp/*/* "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ +# sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ +# sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.5/Makefile b/linux/ecosystem/atlassian/crowd/0/0.4.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.5/README.md b/linux/ecosystem/atlassian/crowd/0/0.4.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/0/0.4.5/docker-compose.yml new file mode 100644 index 000000000..90ff69aeb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.5/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:0.4.5" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:0.4.5-jdk6" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/0/0.4.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/0/0.4.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/0/0.4/.env b/linux/ecosystem/atlassian/crowd/0/0.4/.env new file mode 100644 index 000000000..fb2ecc37d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4/.env @@ -0,0 +1,3 @@ +RELEASE=0.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/crowd-${RELEASE}-std.zip +TEMP_ARCHIVE=/tmp/crowd-${RELEASE}-std.zip diff --git a/linux/ecosystem/atlassian/crowd/0/0.4/Dockerfile b/linux/ecosystem/atlassian/crowd/0/0.4/Dockerfile new file mode 100644 index 000000000..66f79f27e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=0.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/crowd-0.4-std.zip +ARG TEMP_ARCHIVE=/tmp/crowd-0.4-std.zip + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + 7zz x ${TEMP_ARCHIVE} -o/tmp/crowd-temp && \ + mv /tmp/crowd-temp/*/* "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ +# sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ +# sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/0/0.4/Makefile b/linux/ecosystem/atlassian/crowd/0/0.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/0/0.4/README.md b/linux/ecosystem/atlassian/crowd/0/0.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/0/0.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/0/0.4/docker-compose.yml new file mode 100644 index 000000000..cf745739c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:0.4" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:0.4-jdk6" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/0/0.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/0/0.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/0/0.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.3.2/.env b/linux/ecosystem/atlassian/crowd/1/1.3.2/.env new file mode 100644 index 000000000..2c4847977 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3.2/.env @@ -0,0 +1,3 @@ +RELEASE=1.3.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.3.2/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.3.2/Dockerfile new file mode 100644 index 000000000..ca60ba149 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.3.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.3.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.3.2/Dockerfile.jdk7 new file mode 100644 index 000000000..78ed0bcf9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3.2/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.3.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.3.2/Makefile b/linux/ecosystem/atlassian/crowd/1/1.3.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.3.2/README.md b/linux/ecosystem/atlassian/crowd/1/1.3.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.3.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.3.2/docker-compose.yml new file mode 100644 index 000000000..d46584832 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.3.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.3.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.3.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.3.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.3.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.3.3/.env b/linux/ecosystem/atlassian/crowd/1/1.3.3/.env new file mode 100644 index 000000000..3e6e769c4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3.3/.env @@ -0,0 +1,3 @@ +RELEASE=1.3.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.3.3/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.3.3/Dockerfile new file mode 100644 index 000000000..56bf59fd9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3.3/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.3.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.3.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.3.3/Dockerfile.jdk7 new file mode 100644 index 000000000..622305954 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3.3/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.3.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.3.3/Makefile b/linux/ecosystem/atlassian/crowd/1/1.3.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.3.3/README.md b/linux/ecosystem/atlassian/crowd/1/1.3.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.3.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.3.3/docker-compose.yml new file mode 100644 index 000000000..e630eec22 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.3.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.3.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.3.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.3.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.3.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.3/.env b/linux/ecosystem/atlassian/crowd/1/1.3/.env new file mode 100644 index 000000000..3aa2f72df --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3/.env @@ -0,0 +1,3 @@ +RELEASE=1.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.3/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.3/Dockerfile new file mode 100644 index 000000000..bcad0cc65 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.3/Dockerfile.jdk7 new file mode 100644 index 000000000..dea445b2a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.3/Makefile b/linux/ecosystem/atlassian/crowd/1/1.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.3/README.md b/linux/ecosystem/atlassian/crowd/1/1.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.3/docker-compose.yml new file mode 100644 index 000000000..191555df9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.2/.env b/linux/ecosystem/atlassian/crowd/1/1.4.2/.env new file mode 100644 index 000000000..da6f2a36b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.2/.env @@ -0,0 +1,3 @@ +RELEASE=1.4.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.2/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.4.2/Dockerfile new file mode 100644 index 000000000..998af70fd --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.4.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.4.2/Dockerfile.jdk7 new file mode 100644 index 000000000..a89e1e977 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.2/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.4.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.2/Makefile b/linux/ecosystem/atlassian/crowd/1/1.4.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.2/README.md b/linux/ecosystem/atlassian/crowd/1/1.4.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.4.2/docker-compose.yml new file mode 100644 index 000000000..3f5bff76c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.4.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.4.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.4.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.4.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.3/.env b/linux/ecosystem/atlassian/crowd/1/1.4.3/.env new file mode 100644 index 000000000..935d302cc --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.3/.env @@ -0,0 +1,3 @@ +RELEASE=1.4.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.3/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.4.3/Dockerfile new file mode 100644 index 000000000..971cfb330 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.3/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.4.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.4.3/Dockerfile.jdk7 new file mode 100644 index 000000000..442f13b45 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.3/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.4.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.3/Makefile b/linux/ecosystem/atlassian/crowd/1/1.4.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.3/README.md b/linux/ecosystem/atlassian/crowd/1/1.4.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.4.3/docker-compose.yml new file mode 100644 index 000000000..db8a2e7cd --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.4.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.4.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.4.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.4.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.4/.env b/linux/ecosystem/atlassian/crowd/1/1.4.4/.env new file mode 100644 index 000000000..65e00c764 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.4/.env @@ -0,0 +1,3 @@ +RELEASE=1.4.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.4/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.4.4/Dockerfile new file mode 100644 index 000000000..340b35640 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.4/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.4.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.4/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.4.4/Dockerfile.jdk7 new file mode 100644 index 000000000..3d8e1acd4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.4/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.4.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.4/Makefile b/linux/ecosystem/atlassian/crowd/1/1.4.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.4/README.md b/linux/ecosystem/atlassian/crowd/1/1.4.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.4.4/docker-compose.yml new file mode 100644 index 000000000..a17d8138c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.4.4" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.4.4-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.4.4-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.4.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.7/.env b/linux/ecosystem/atlassian/crowd/1/1.4.7/.env new file mode 100644 index 000000000..34e7e2bd0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.7/.env @@ -0,0 +1,3 @@ +RELEASE=1.4.7 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.7/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.4.7/Dockerfile new file mode 100644 index 000000000..37a4e07ea --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.7/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.4.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.7/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.4.7/Dockerfile.jdk7 new file mode 100644 index 000000000..a98d1d6dd --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.7/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.4.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.7/Makefile b/linux/ecosystem/atlassian/crowd/1/1.4.7/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.7/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.7/README.md b/linux/ecosystem/atlassian/crowd/1/1.4.7/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.7/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.7/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.4.7/docker-compose.yml new file mode 100644 index 000000000..aaa288b74 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.7/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.4.7" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.4.7-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.4.7-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.7/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.4.7/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.7/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.8/.env b/linux/ecosystem/atlassian/crowd/1/1.4.8/.env new file mode 100644 index 000000000..dc3fe37dd --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.8/.env @@ -0,0 +1,3 @@ +RELEASE=1.4.8 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.8/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.4.8/Dockerfile new file mode 100644 index 000000000..85823604d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.8/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.4.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.8/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.4.8/Dockerfile.jdk7 new file mode 100644 index 000000000..28356e961 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.8/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.4.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.8/Makefile b/linux/ecosystem/atlassian/crowd/1/1.4.8/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.8/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.8/README.md b/linux/ecosystem/atlassian/crowd/1/1.4.8/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.8/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.8/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.4.8/docker-compose.yml new file mode 100644 index 000000000..ee892a1a6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.8/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.4.8" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.4.8-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.4.8-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.4.8/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.4.8/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4.8/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.4/.env b/linux/ecosystem/atlassian/crowd/1/1.4/.env new file mode 100644 index 000000000..dca0ed7c5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4/.env @@ -0,0 +1,3 @@ +RELEASE=1.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.4/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.4/Dockerfile new file mode 100644 index 000000000..1f133df00 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.4/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.4/Dockerfile.jdk7 new file mode 100644 index 000000000..f745e23eb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.4/Makefile b/linux/ecosystem/atlassian/crowd/1/1.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.4/README.md b/linux/ecosystem/atlassian/crowd/1/1.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.4/docker-compose.yml new file mode 100644 index 000000000..8e74b84f4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.4" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.4-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.4-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.1/.env b/linux/ecosystem/atlassian/crowd/1/1.5.1/.env new file mode 100644 index 000000000..9c2bb9242 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.1/.env @@ -0,0 +1,3 @@ +RELEASE=1.5.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.1/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.5.1/Dockerfile new file mode 100644 index 000000000..31a038e3c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.1/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.5.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.5.1/Dockerfile.jdk7 new file mode 100644 index 000000000..84e0a48a5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.1/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.5.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.1/Makefile b/linux/ecosystem/atlassian/crowd/1/1.5.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.1/README.md b/linux/ecosystem/atlassian/crowd/1/1.5.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.5.1/docker-compose.yml new file mode 100644 index 000000000..2b5f8c122 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.5.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.5.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.5.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.5.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.2/.env b/linux/ecosystem/atlassian/crowd/1/1.5.2/.env new file mode 100644 index 000000000..c9a656847 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.2/.env @@ -0,0 +1,3 @@ +RELEASE=1.5.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.2/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.5.2/Dockerfile new file mode 100644 index 000000000..ebc820c9f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.5.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.5.2/Dockerfile.jdk7 new file mode 100644 index 000000000..8dccfa9f1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.2/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.5.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.2/Makefile b/linux/ecosystem/atlassian/crowd/1/1.5.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.2/README.md b/linux/ecosystem/atlassian/crowd/1/1.5.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.5.2/docker-compose.yml new file mode 100644 index 000000000..9a99a0a8d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.5.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.5.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.5.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.5.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.3/.env b/linux/ecosystem/atlassian/crowd/1/1.5.3/.env new file mode 100644 index 000000000..d690354a1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.3/.env @@ -0,0 +1,3 @@ +RELEASE=1.5.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.3/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.5.3/Dockerfile new file mode 100644 index 000000000..1d6370150 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.3/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.5.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.5.3/Dockerfile.jdk7 new file mode 100644 index 000000000..82743b3b0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.3/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.5.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.3/Makefile b/linux/ecosystem/atlassian/crowd/1/1.5.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.3/README.md b/linux/ecosystem/atlassian/crowd/1/1.5.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.5.3/docker-compose.yml new file mode 100644 index 000000000..b90bd2f7d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.5.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.5.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.5.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.5.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.5.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.5/.env b/linux/ecosystem/atlassian/crowd/1/1.5/.env new file mode 100644 index 000000000..f328d7e10 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5/.env @@ -0,0 +1,3 @@ +RELEASE=1.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.5/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.5/Dockerfile new file mode 100644 index 000000000..dfd2117a6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.5/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.5/Dockerfile.jdk7 new file mode 100644 index 000000000..9d927b194 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.5/Makefile b/linux/ecosystem/atlassian/crowd/1/1.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.5/README.md b/linux/ecosystem/atlassian/crowd/1/1.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.5/docker-compose.yml new file mode 100644 index 000000000..c58f3603c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.5" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.5-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.5-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.6.1/.env b/linux/ecosystem/atlassian/crowd/1/1.6.1/.env new file mode 100644 index 000000000..b1c617b42 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6.1/.env @@ -0,0 +1,3 @@ +RELEASE=1.6.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.6.1/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.6.1/Dockerfile new file mode 100644 index 000000000..1e8887737 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6.1/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.6.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.6.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.6.1/Dockerfile.jdk7 new file mode 100644 index 000000000..d474023a8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6.1/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.6.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.6.1/Makefile b/linux/ecosystem/atlassian/crowd/1/1.6.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.6.1/README.md b/linux/ecosystem/atlassian/crowd/1/1.6.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.6.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.6.1/docker-compose.yml new file mode 100644 index 000000000..94d073696 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.6.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.6.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.6.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.6.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.6.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.6.3/.env b/linux/ecosystem/atlassian/crowd/1/1.6.3/.env new file mode 100644 index 000000000..41f569eec --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6.3/.env @@ -0,0 +1,3 @@ +RELEASE=1.6.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.6.3/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.6.3/Dockerfile new file mode 100644 index 000000000..62a74f5ee --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6.3/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.6.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.6.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.6.3/Dockerfile.jdk7 new file mode 100644 index 000000000..cbe0d9f96 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6.3/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.6.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.6.3/Makefile b/linux/ecosystem/atlassian/crowd/1/1.6.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.6.3/README.md b/linux/ecosystem/atlassian/crowd/1/1.6.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.6.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.6.3/docker-compose.yml new file mode 100644 index 000000000..c3524eb5e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.6.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.6.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.6.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.6.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.6.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/1/1.6/.env b/linux/ecosystem/atlassian/crowd/1/1.6/.env new file mode 100644 index 000000000..336cf0aa5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6/.env @@ -0,0 +1,3 @@ +RELEASE=1.6 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/1/1.6/Dockerfile b/linux/ecosystem/atlassian/crowd/1/1.6/Dockerfile new file mode 100644 index 000000000..135178acd --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.6/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/1/1.6/Dockerfile.jdk7 new file mode 100644 index 000000000..ac8745494 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=1.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/1/1.6/Makefile b/linux/ecosystem/atlassian/crowd/1/1.6/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/1/1.6/README.md b/linux/ecosystem/atlassian/crowd/1/1.6/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/1/1.6/docker-compose.yml b/linux/ecosystem/atlassian/crowd/1/1.6/docker-compose.yml new file mode 100644 index 000000000..fb4c2c88b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:1.6" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:1.6-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:1.6-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/1/1.6/entrypoint.sh b/linux/ecosystem/atlassian/crowd/1/1.6/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/1/1.6/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.0/.env b/linux/ecosystem/atlassian/crowd/2/2.0.0/.env new file mode 100644 index 000000000..891f51214 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.0/.env @@ -0,0 +1,3 @@ +RELEASE=2.0.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.0/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.0.0/Dockerfile new file mode 100644 index 000000000..6f22bca16 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.0/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.0.0/Dockerfile.jdk7 new file mode 100644 index 000000000..5bdd90923 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.0/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.0/Makefile b/linux/ecosystem/atlassian/crowd/2/2.0.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.0/README.md b/linux/ecosystem/atlassian/crowd/2/2.0.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.0.0/docker-compose.yml new file mode 100644 index 000000000..cdcb88ab4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.0.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.0.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.0.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.0.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.1/.env b/linux/ecosystem/atlassian/crowd/2/2.0.1/.env new file mode 100644 index 000000000..bd0d71b44 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.1/.env @@ -0,0 +1,3 @@ +RELEASE=2.0.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.1/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.0.1/Dockerfile new file mode 100644 index 000000000..65c1585ef --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.1/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.0.1/Dockerfile.jdk7 new file mode 100644 index 000000000..82c911023 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.1/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.1/Makefile b/linux/ecosystem/atlassian/crowd/2/2.0.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.1/README.md b/linux/ecosystem/atlassian/crowd/2/2.0.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.0.1/docker-compose.yml new file mode 100644 index 000000000..c1cf4ba96 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.0.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.0.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.0.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.0.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.2/.env b/linux/ecosystem/atlassian/crowd/2/2.0.2/.env new file mode 100644 index 000000000..25f81b155 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.2/.env @@ -0,0 +1,3 @@ +RELEASE=2.0.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.2/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.0.2/Dockerfile new file mode 100644 index 000000000..8df0f4666 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.0.2/Dockerfile.jdk7 new file mode 100644 index 000000000..782a5e3b2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.2/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.2/Makefile b/linux/ecosystem/atlassian/crowd/2/2.0.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.2/README.md b/linux/ecosystem/atlassian/crowd/2/2.0.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.0.2/docker-compose.yml new file mode 100644 index 000000000..d894206c7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.0.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.0.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.0.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.0.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.3/.env b/linux/ecosystem/atlassian/crowd/2/2.0.3/.env new file mode 100644 index 000000000..fc37c2b50 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.3/.env @@ -0,0 +1,3 @@ +RELEASE=2.0.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.3/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.0.3/Dockerfile new file mode 100644 index 000000000..658d84d99 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.3/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.0.3/Dockerfile.jdk7 new file mode 100644 index 000000000..e23f7a7c6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.3/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.3/Makefile b/linux/ecosystem/atlassian/crowd/2/2.0.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.3/README.md b/linux/ecosystem/atlassian/crowd/2/2.0.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.0.3/docker-compose.yml new file mode 100644 index 000000000..4ced7a275 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.0.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.0.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.0.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.0.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.4/.env b/linux/ecosystem/atlassian/crowd/2/2.0.4/.env new file mode 100644 index 000000000..0de02fd84 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.4/.env @@ -0,0 +1,3 @@ +RELEASE=2.0.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.4/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.0.4/Dockerfile new file mode 100644 index 000000000..54ab58bff --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.4/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.4/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.0.4/Dockerfile.jdk7 new file mode 100644 index 000000000..bfce5f502 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.4/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.4/Makefile b/linux/ecosystem/atlassian/crowd/2/2.0.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.4/README.md b/linux/ecosystem/atlassian/crowd/2/2.0.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.0.4/docker-compose.yml new file mode 100644 index 000000000..ade3cd163 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.0.4" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.0.4-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.0.4-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.0.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.5/.env b/linux/ecosystem/atlassian/crowd/2/2.0.5/.env new file mode 100644 index 000000000..9c7e06577 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.5/.env @@ -0,0 +1,3 @@ +RELEASE=2.0.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.5/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.0.5/Dockerfile new file mode 100644 index 000000000..4af483a13 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.5/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.5/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.0.5/Dockerfile.jdk7 new file mode 100644 index 000000000..d8eb10941 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.5/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.5/Makefile b/linux/ecosystem/atlassian/crowd/2/2.0.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.5/README.md b/linux/ecosystem/atlassian/crowd/2/2.0.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.0.5/docker-compose.yml new file mode 100644 index 000000000..4657e0fda --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.0.5" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.0.5-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.0.5-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.0.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.6/.env b/linux/ecosystem/atlassian/crowd/2/2.0.6/.env new file mode 100644 index 000000000..6c98c23ad --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.6/.env @@ -0,0 +1,3 @@ +RELEASE=2.0.6 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.6/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.0.6/Dockerfile new file mode 100644 index 000000000..0de217e5f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.6/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.6/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.0.6/Dockerfile.jdk7 new file mode 100644 index 000000000..ee969ad05 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.6/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.6/Makefile b/linux/ecosystem/atlassian/crowd/2/2.0.6/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.6/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.6/README.md b/linux/ecosystem/atlassian/crowd/2/2.0.6/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.6/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.6/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.0.6/docker-compose.yml new file mode 100644 index 000000000..830aec738 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.6/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.0.6" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.0.6-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.0.6-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.6/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.0.6/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.6/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.7/.env b/linux/ecosystem/atlassian/crowd/2/2.0.7/.env new file mode 100644 index 000000000..d07f6c45b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.7/.env @@ -0,0 +1,3 @@ +RELEASE=2.0.7 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.7/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.0.7/Dockerfile new file mode 100644 index 000000000..75eb55c3c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.7/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.7/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.0.7/Dockerfile.jdk7 new file mode 100644 index 000000000..cca4d2481 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.7/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.7/Makefile b/linux/ecosystem/atlassian/crowd/2/2.0.7/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.7/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.7/README.md b/linux/ecosystem/atlassian/crowd/2/2.0.7/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.7/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.7/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.0.7/docker-compose.yml new file mode 100644 index 000000000..0aa28da2e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.7/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.0.7" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.0.7-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.0.7-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.7/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.0.7/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.7/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.9/.env b/linux/ecosystem/atlassian/crowd/2/2.0.9/.env new file mode 100644 index 000000000..34bc628b2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.9/.env @@ -0,0 +1,3 @@ +RELEASE=2.0.9 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.9/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.0.9/Dockerfile new file mode 100644 index 000000000..ec748f586 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.9/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.9/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.0.9/Dockerfile.jdk7 new file mode 100644 index 000000000..d2edc8bc2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.9/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.0.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.9/Makefile b/linux/ecosystem/atlassian/crowd/2/2.0.9/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.9/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.9/README.md b/linux/ecosystem/atlassian/crowd/2/2.0.9/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.9/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.9/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.0.9/docker-compose.yml new file mode 100644 index 000000000..8b66d366f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.9/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.0.9" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.0.9-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.0.9-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.0.9/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.0.9/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.0.9/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/.env b/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/.env new file mode 100644 index 000000000..bfc881423 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/.env @@ -0,0 +1,3 @@ +RELEASE=2.1.0-beta4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/Dockerfile new file mode 100644 index 000000000..ab934218f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.1.0-beta4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/Dockerfile.jdk7 new file mode 100644 index 000000000..adeb970a2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.1.0-beta4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/Makefile b/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/README.md b/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/docker-compose.yml new file mode 100644 index 000000000..cae24fae3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.1.0-beta4" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.1.0-beta4-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.1.0-beta4-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.0-beta4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.0/.env b/linux/ecosystem/atlassian/crowd/2/2.1.0/.env new file mode 100644 index 000000000..946ff8df7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.0/.env @@ -0,0 +1,3 @@ +RELEASE=2.1.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.0/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.1.0/Dockerfile new file mode 100644 index 000000000..539282786 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.0/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.1.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.1.0/Dockerfile.jdk7 new file mode 100644 index 000000000..652be02c8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.0/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.1.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.0/Makefile b/linux/ecosystem/atlassian/crowd/2/2.1.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.0/README.md b/linux/ecosystem/atlassian/crowd/2/2.1.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.1.0/docker-compose.yml new file mode 100644 index 000000000..0e9319d78 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.1.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.1.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.1.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.1.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.1/.env b/linux/ecosystem/atlassian/crowd/2/2.1.1/.env new file mode 100644 index 000000000..0c888bfb4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.1/.env @@ -0,0 +1,3 @@ +RELEASE=2.1.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.1/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.1.1/Dockerfile new file mode 100644 index 000000000..79b2bf583 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.1/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.1.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.1.1/Dockerfile.jdk7 new file mode 100644 index 000000000..ca5e119ab --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.1/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.1.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.1/Makefile b/linux/ecosystem/atlassian/crowd/2/2.1.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.1/README.md b/linux/ecosystem/atlassian/crowd/2/2.1.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.1.1/docker-compose.yml new file mode 100644 index 000000000..13a8335a3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.1.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.1.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.1.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.1.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.2/.env b/linux/ecosystem/atlassian/crowd/2/2.1.2/.env new file mode 100644 index 000000000..26af0395d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.2/.env @@ -0,0 +1,3 @@ +RELEASE=2.1.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.2/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.1.2/Dockerfile new file mode 100644 index 000000000..c0098919c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.1.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.1.2/Dockerfile.jdk7 new file mode 100644 index 000000000..b225b0f38 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.2/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.1.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.2/Makefile b/linux/ecosystem/atlassian/crowd/2/2.1.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.2/README.md b/linux/ecosystem/atlassian/crowd/2/2.1.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.1.2/docker-compose.yml new file mode 100644 index 000000000..88c93f883 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.1.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.1.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.1.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.1.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.1.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.1.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.1/.env b/linux/ecosystem/atlassian/crowd/2/2.10.1/.env new file mode 100644 index 000000000..45f964df9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.1/.env @@ -0,0 +1,3 @@ +RELEASE=2.10.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.1/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.10.1/Dockerfile new file mode 100644 index 000000000..5fd766002 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.1/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.10.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.10.1/Dockerfile.jdk7 new file mode 100644 index 000000000..2f62b7fd0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.1/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.10.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.1/Makefile b/linux/ecosystem/atlassian/crowd/2/2.10.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.1/README.md b/linux/ecosystem/atlassian/crowd/2/2.10.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.10.1/docker-compose.yml new file mode 100644 index 000000000..e3a0aa369 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.10.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.10.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.10.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.10.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.2/.env b/linux/ecosystem/atlassian/crowd/2/2.10.2/.env new file mode 100644 index 000000000..d00787f52 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.2/.env @@ -0,0 +1,3 @@ +RELEASE=2.10.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.2/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.10.2/Dockerfile new file mode 100644 index 000000000..d9acfc7d0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.10.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.10.2/Dockerfile.jdk7 new file mode 100644 index 000000000..4383a3b1c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.2/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.10.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.2/Makefile b/linux/ecosystem/atlassian/crowd/2/2.10.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.2/README.md b/linux/ecosystem/atlassian/crowd/2/2.10.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.10.2/docker-compose.yml new file mode 100644 index 000000000..21a9139da --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.10.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.10.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.10.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.10.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.3/.env b/linux/ecosystem/atlassian/crowd/2/2.10.3/.env new file mode 100644 index 000000000..0f2d0f47c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.3/.env @@ -0,0 +1,3 @@ +RELEASE=2.10.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.3/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.10.3/Dockerfile new file mode 100644 index 000000000..e1ab0d68c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.3/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.10.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.10.3/Dockerfile.jdk7 new file mode 100644 index 000000000..20cd29504 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.3/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.10.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.3/Makefile b/linux/ecosystem/atlassian/crowd/2/2.10.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.3/README.md b/linux/ecosystem/atlassian/crowd/2/2.10.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.10.3/docker-compose.yml new file mode 100644 index 000000000..a69ca035f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.10.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.10.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.10.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.10.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.10.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.10.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.0/.env b/linux/ecosystem/atlassian/crowd/2/2.11.0/.env new file mode 100644 index 000000000..22423c266 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.0/.env @@ -0,0 +1,3 @@ +RELEASE=2.11.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.0/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.11.0/Dockerfile new file mode 100644 index 000000000..8b1502d06 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.0/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.11.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.11.0/Dockerfile.jdk7 new file mode 100644 index 000000000..1aeec2dc9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.0/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.11.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.0/Makefile b/linux/ecosystem/atlassian/crowd/2/2.11.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.0/README.md b/linux/ecosystem/atlassian/crowd/2/2.11.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.11.0/docker-compose.yml new file mode 100644 index 000000000..0398fd120 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.11.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.11.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.11.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.11.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.1/.env b/linux/ecosystem/atlassian/crowd/2/2.11.1/.env new file mode 100644 index 000000000..cce962d22 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.1/.env @@ -0,0 +1,3 @@ +RELEASE=2.11.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.1/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.11.1/Dockerfile new file mode 100644 index 000000000..72b516aad --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.1/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.11.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.11.1/Dockerfile.jdk7 new file mode 100644 index 000000000..4533b8269 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.1/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.11.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.1/Makefile b/linux/ecosystem/atlassian/crowd/2/2.11.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.1/README.md b/linux/ecosystem/atlassian/crowd/2/2.11.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.11.1/docker-compose.yml new file mode 100644 index 000000000..f175d429a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.11.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.11.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.11.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.11.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.2/.env b/linux/ecosystem/atlassian/crowd/2/2.11.2/.env new file mode 100644 index 000000000..80f0a30d3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.2/.env @@ -0,0 +1,3 @@ +RELEASE=2.11.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.2/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.11.2/Dockerfile new file mode 100644 index 000000000..eb3adfa1a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.11.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.11.2/Dockerfile.jdk7 new file mode 100644 index 000000000..87f23350f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.2/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.11.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.2/Makefile b/linux/ecosystem/atlassian/crowd/2/2.11.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.2/README.md b/linux/ecosystem/atlassian/crowd/2/2.11.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.11.2/docker-compose.yml new file mode 100644 index 000000000..a938546b7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.11.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.11.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.11.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.11.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.11.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.11.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.12.0/.env b/linux/ecosystem/atlassian/crowd/2/2.12.0/.env new file mode 100644 index 000000000..fb61ae503 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.12.0/.env @@ -0,0 +1,3 @@ +RELEASE=2.12.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.12.0/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.12.0/Dockerfile new file mode 100644 index 000000000..d86224c98 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.12.0/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.12.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.12.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.12.0/Dockerfile.jdk7 new file mode 100644 index 000000000..6d6091212 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.12.0/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.12.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.12.0/Makefile b/linux/ecosystem/atlassian/crowd/2/2.12.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.12.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.12.0/README.md b/linux/ecosystem/atlassian/crowd/2/2.12.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.12.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.12.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.12.0/docker-compose.yml new file mode 100644 index 000000000..592778589 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.12.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.12.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.12.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.12.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.12.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.12.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.12.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.2/.env b/linux/ecosystem/atlassian/crowd/2/2.2.2/.env new file mode 100644 index 000000000..6de719fa8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.2/.env @@ -0,0 +1,3 @@ +RELEASE=2.2.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.2/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.2.2/Dockerfile new file mode 100644 index 000000000..f51b3009b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.2.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.2.2/Dockerfile.jdk7 new file mode 100644 index 000000000..513d3ea6f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.2/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.2.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.2/Makefile b/linux/ecosystem/atlassian/crowd/2/2.2.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.2/README.md b/linux/ecosystem/atlassian/crowd/2/2.2.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.2.2/docker-compose.yml new file mode 100644 index 000000000..344b30777 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.2.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.2.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.2.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.2.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.4/.env b/linux/ecosystem/atlassian/crowd/2/2.2.4/.env new file mode 100644 index 000000000..4ac3e2cce --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.4/.env @@ -0,0 +1,3 @@ +RELEASE=2.2.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.4/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.2.4/Dockerfile new file mode 100644 index 000000000..a585243c0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.4/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.2.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.4/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.2.4/Dockerfile.jdk7 new file mode 100644 index 000000000..cd696f86d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.4/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.2.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.4/Makefile b/linux/ecosystem/atlassian/crowd/2/2.2.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.4/README.md b/linux/ecosystem/atlassian/crowd/2/2.2.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.2.4/docker-compose.yml new file mode 100644 index 000000000..2772877ae --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.2.4" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.2.4-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.2.4-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.2.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.7/.env b/linux/ecosystem/atlassian/crowd/2/2.2.7/.env new file mode 100644 index 000000000..f6bebc049 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.7/.env @@ -0,0 +1,3 @@ +RELEASE=2.2.7 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.7/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.2.7/Dockerfile new file mode 100644 index 000000000..a5ec1ae40 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.7/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.2.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.7/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.2.7/Dockerfile.jdk7 new file mode 100644 index 000000000..2f4cf1623 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.7/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.2.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.7/Makefile b/linux/ecosystem/atlassian/crowd/2/2.2.7/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.7/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.7/README.md b/linux/ecosystem/atlassian/crowd/2/2.2.7/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.7/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.7/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.2.7/docker-compose.yml new file mode 100644 index 000000000..dd4af203a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.7/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.2.7" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.2.7-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.2.7-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.7/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.2.7/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.7/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.9/.env b/linux/ecosystem/atlassian/crowd/2/2.2.9/.env new file mode 100644 index 000000000..08640fcca --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.9/.env @@ -0,0 +1,3 @@ +RELEASE=2.2.9 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.9/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.2.9/Dockerfile new file mode 100644 index 000000000..88bf1a927 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.9/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.2.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.9/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.2.9/Dockerfile.jdk7 new file mode 100644 index 000000000..0ab6bfc6a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.9/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.2.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.9/Makefile b/linux/ecosystem/atlassian/crowd/2/2.2.9/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.9/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.9/README.md b/linux/ecosystem/atlassian/crowd/2/2.2.9/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.9/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.9/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.2.9/docker-compose.yml new file mode 100644 index 000000000..4fe873087 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.9/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.2.9" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.2.9-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.2.9-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.2.9/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.2.9/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.2.9/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.1/.env b/linux/ecosystem/atlassian/crowd/2/2.3.1/.env new file mode 100644 index 000000000..15ebff687 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.1/.env @@ -0,0 +1,3 @@ +RELEASE=2.3.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.1/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.3.1/Dockerfile new file mode 100644 index 000000000..401358934 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.1/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.3.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.3.1/Dockerfile.jdk7 new file mode 100644 index 000000000..03f00299a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.1/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.3.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.1/Makefile b/linux/ecosystem/atlassian/crowd/2/2.3.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.1/README.md b/linux/ecosystem/atlassian/crowd/2/2.3.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.3.1/docker-compose.yml new file mode 100644 index 000000000..ebd7c18c3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.3.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.3.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.3.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.3.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.2/.env b/linux/ecosystem/atlassian/crowd/2/2.3.2/.env new file mode 100644 index 000000000..0dd941c95 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.2/.env @@ -0,0 +1,3 @@ +RELEASE=2.3.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.2/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.3.2/Dockerfile new file mode 100644 index 000000000..c10e48820 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.3.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.3.2/Dockerfile.jdk7 new file mode 100644 index 000000000..8a4b94527 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.2/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.3.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.2/Makefile b/linux/ecosystem/atlassian/crowd/2/2.3.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.2/README.md b/linux/ecosystem/atlassian/crowd/2/2.3.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.3.2/docker-compose.yml new file mode 100644 index 000000000..aae026536 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.3.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.3.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.3.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.3.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.3/.env b/linux/ecosystem/atlassian/crowd/2/2.3.3/.env new file mode 100644 index 000000000..5febd87fa --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.3/.env @@ -0,0 +1,3 @@ +RELEASE=2.3.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.3/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.3.3/Dockerfile new file mode 100644 index 000000000..6fe69fda7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.3/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.3.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.3.3/Dockerfile.jdk7 new file mode 100644 index 000000000..d2840632b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.3/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.3.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.3/Makefile b/linux/ecosystem/atlassian/crowd/2/2.3.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.3/README.md b/linux/ecosystem/atlassian/crowd/2/2.3.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.3.3/docker-compose.yml new file mode 100644 index 000000000..15d2ae678 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.3.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.3.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.3.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.3.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.4/.env b/linux/ecosystem/atlassian/crowd/2/2.3.4/.env new file mode 100644 index 000000000..4433c00ca --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.4/.env @@ -0,0 +1,3 @@ +RELEASE=2.3.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.4/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.3.4/Dockerfile new file mode 100644 index 000000000..43d2f8801 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.4/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.3.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.4/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.3.4/Dockerfile.jdk7 new file mode 100644 index 000000000..2898f613b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.4/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.3.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.4/Makefile b/linux/ecosystem/atlassian/crowd/2/2.3.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.4/README.md b/linux/ecosystem/atlassian/crowd/2/2.3.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.3.4/docker-compose.yml new file mode 100644 index 000000000..4aff31037 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.3.4" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.3.4-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.3.4-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.3.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.6/.env b/linux/ecosystem/atlassian/crowd/2/2.3.6/.env new file mode 100644 index 000000000..eeef259f1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.6/.env @@ -0,0 +1,3 @@ +RELEASE=2.3.6 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.6/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.3.6/Dockerfile new file mode 100644 index 000000000..8bd6778a6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.6/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.3.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.6/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.3.6/Dockerfile.jdk7 new file mode 100644 index 000000000..aa00d515f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.6/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.3.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.6/Makefile b/linux/ecosystem/atlassian/crowd/2/2.3.6/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.6/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.6/README.md b/linux/ecosystem/atlassian/crowd/2/2.3.6/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.6/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.6/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.3.6/docker-compose.yml new file mode 100644 index 000000000..70168a0bd --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.6/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.3.6" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.3.6-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.3.6-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.6/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.3.6/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.6/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.7/.env b/linux/ecosystem/atlassian/crowd/2/2.3.7/.env new file mode 100644 index 000000000..c08cd0e4a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.7/.env @@ -0,0 +1,3 @@ +RELEASE=2.3.7 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.7/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.3.7/Dockerfile new file mode 100644 index 000000000..fde48c3e3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.7/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.3.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.7/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.3.7/Dockerfile.jdk7 new file mode 100644 index 000000000..e6ddf6933 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.7/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.3.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.7/Makefile b/linux/ecosystem/atlassian/crowd/2/2.3.7/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.7/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.7/README.md b/linux/ecosystem/atlassian/crowd/2/2.3.7/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.7/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.7/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.3.7/docker-compose.yml new file mode 100644 index 000000000..c5b66e934 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.7/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.3.7" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.3.7-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.3.7-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.7/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.3.7/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.7/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.9/.env b/linux/ecosystem/atlassian/crowd/2/2.3.9/.env new file mode 100644 index 000000000..092bece0d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.9/.env @@ -0,0 +1,3 @@ +RELEASE=2.3.9 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.9/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.3.9/Dockerfile new file mode 100644 index 000000000..b640886a6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.9/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.3.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.9/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.3.9/Dockerfile.jdk7 new file mode 100644 index 000000000..3408506c0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.9/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.3.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.9/Makefile b/linux/ecosystem/atlassian/crowd/2/2.3.9/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.9/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.9/README.md b/linux/ecosystem/atlassian/crowd/2/2.3.9/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.9/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.9/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.3.9/docker-compose.yml new file mode 100644 index 000000000..9eb37628f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.9/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.3.9" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.3.9-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.3.9-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.3.9/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.3.9/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.3.9/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.0/.env b/linux/ecosystem/atlassian/crowd/2/2.4.0/.env new file mode 100644 index 000000000..49b372f3e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.0/.env @@ -0,0 +1,3 @@ +RELEASE=2.4.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.0/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.4.0/Dockerfile new file mode 100644 index 000000000..dc95e6c2d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.0/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.4.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.4.0/Dockerfile.jdk7 new file mode 100644 index 000000000..8749e047b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.0/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.4.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.0/Makefile b/linux/ecosystem/atlassian/crowd/2/2.4.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.0/README.md b/linux/ecosystem/atlassian/crowd/2/2.4.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.4.0/docker-compose.yml new file mode 100644 index 000000000..f5fcacdb5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.4.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.4.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.4.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.4.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.1/.env b/linux/ecosystem/atlassian/crowd/2/2.4.1/.env new file mode 100644 index 000000000..e29185237 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.1/.env @@ -0,0 +1,3 @@ +RELEASE=2.4.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.1/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.4.1/Dockerfile new file mode 100644 index 000000000..229368aba --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.1/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.4.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.4.1/Dockerfile.jdk7 new file mode 100644 index 000000000..37ad8266e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.1/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.4.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.1/Makefile b/linux/ecosystem/atlassian/crowd/2/2.4.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.1/README.md b/linux/ecosystem/atlassian/crowd/2/2.4.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.4.1/docker-compose.yml new file mode 100644 index 000000000..57c574193 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.4.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.4.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.4.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.4.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.10/.env b/linux/ecosystem/atlassian/crowd/2/2.4.10/.env new file mode 100644 index 000000000..9928d3106 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.10/.env @@ -0,0 +1,3 @@ +RELEASE=2.4.10 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.10/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.4.10/Dockerfile new file mode 100644 index 000000000..7840bb2c6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.10/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.4.10 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.10/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.4.10/Dockerfile.jdk7 new file mode 100644 index 000000000..ee8c0d48f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.10/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.4.10 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.10/Makefile b/linux/ecosystem/atlassian/crowd/2/2.4.10/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.10/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.10/README.md b/linux/ecosystem/atlassian/crowd/2/2.4.10/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.10/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.10/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.4.10/docker-compose.yml new file mode 100644 index 000000000..8fcad0a22 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.10/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.4.10" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.4.10-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.4.10-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.10/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.4.10/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.10/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.2/.env b/linux/ecosystem/atlassian/crowd/2/2.4.2/.env new file mode 100644 index 000000000..b4aabaf1e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.2/.env @@ -0,0 +1,3 @@ +RELEASE=2.4.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.2/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.4.2/Dockerfile new file mode 100644 index 000000000..51271ee7c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.4.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.4.2/Dockerfile.jdk7 new file mode 100644 index 000000000..533aaac10 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.2/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.4.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.2/Makefile b/linux/ecosystem/atlassian/crowd/2/2.4.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.2/README.md b/linux/ecosystem/atlassian/crowd/2/2.4.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.4.2/docker-compose.yml new file mode 100644 index 000000000..d51115557 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.4.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.4.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.4.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.4.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.4.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.4.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.0/.env b/linux/ecosystem/atlassian/crowd/2/2.5.0/.env new file mode 100644 index 000000000..75cc9be60 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.0/.env @@ -0,0 +1,3 @@ +RELEASE=2.5.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.0/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.5.0/Dockerfile new file mode 100644 index 000000000..6452a014c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.0/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.5.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.5.0/Dockerfile.jdk7 new file mode 100644 index 000000000..17187d7f8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.0/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.5.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.0/Makefile b/linux/ecosystem/atlassian/crowd/2/2.5.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.0/README.md b/linux/ecosystem/atlassian/crowd/2/2.5.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.5.0/docker-compose.yml new file mode 100644 index 000000000..9fc000391 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.5.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.5.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.5.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.5.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.1/.env b/linux/ecosystem/atlassian/crowd/2/2.5.1/.env new file mode 100644 index 000000000..4aa4278df --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.1/.env @@ -0,0 +1,3 @@ +RELEASE=2.5.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.1/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.5.1/Dockerfile new file mode 100644 index 000000000..59bb3054d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.1/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.5.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.5.1/Dockerfile.jdk7 new file mode 100644 index 000000000..d69768631 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.1/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.5.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.1/Makefile b/linux/ecosystem/atlassian/crowd/2/2.5.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.1/README.md b/linux/ecosystem/atlassian/crowd/2/2.5.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.5.1/docker-compose.yml new file mode 100644 index 000000000..e3432a7a1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.5.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.5.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.5.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.5.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.2/.env b/linux/ecosystem/atlassian/crowd/2/2.5.2/.env new file mode 100644 index 000000000..712d3c900 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.2/.env @@ -0,0 +1,3 @@ +RELEASE=2.5.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.2/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.5.2/Dockerfile new file mode 100644 index 000000000..a3b7468b1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.5.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.5.2/Dockerfile.jdk7 new file mode 100644 index 000000000..ffe9d4653 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.2/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.5.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.2/Makefile b/linux/ecosystem/atlassian/crowd/2/2.5.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.2/README.md b/linux/ecosystem/atlassian/crowd/2/2.5.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.5.2/docker-compose.yml new file mode 100644 index 000000000..11a7c87be --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.5.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.5.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.5.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.5.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.3/.env b/linux/ecosystem/atlassian/crowd/2/2.5.3/.env new file mode 100644 index 000000000..b00218094 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.3/.env @@ -0,0 +1,3 @@ +RELEASE=2.5.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.3/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.5.3/Dockerfile new file mode 100644 index 000000000..7e21ad6c3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.3/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.5.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.5.3/Dockerfile.jdk7 new file mode 100644 index 000000000..aaefd23d3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.3/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.5.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.3/Makefile b/linux/ecosystem/atlassian/crowd/2/2.5.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.3/README.md b/linux/ecosystem/atlassian/crowd/2/2.5.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.5.3/docker-compose.yml new file mode 100644 index 000000000..a83479df5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.5.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.5.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.5.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.5.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.4/.env b/linux/ecosystem/atlassian/crowd/2/2.5.4/.env new file mode 100644 index 000000000..cc7ca6cab --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.4/.env @@ -0,0 +1,3 @@ +RELEASE=2.5.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.4/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.5.4/Dockerfile new file mode 100644 index 000000000..e8de3e8eb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.4/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.5.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.4/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.5.4/Dockerfile.jdk7 new file mode 100644 index 000000000..945a14387 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.4/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.5.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.4/Makefile b/linux/ecosystem/atlassian/crowd/2/2.5.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.4/README.md b/linux/ecosystem/atlassian/crowd/2/2.5.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.5.4/docker-compose.yml new file mode 100644 index 000000000..c3fb5b71a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.5.4" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.5.4-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.5.4-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.5.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.5/.env b/linux/ecosystem/atlassian/crowd/2/2.5.5/.env new file mode 100644 index 000000000..50cbba87a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.5/.env @@ -0,0 +1,3 @@ +RELEASE=2.5.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.5/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.5.5/Dockerfile new file mode 100644 index 000000000..11be508c4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.5/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.5.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.5/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.5.5/Dockerfile.jdk7 new file mode 100644 index 000000000..623972699 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.5/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.5.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.5/Makefile b/linux/ecosystem/atlassian/crowd/2/2.5.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.5/README.md b/linux/ecosystem/atlassian/crowd/2/2.5.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.5.5/docker-compose.yml new file mode 100644 index 000000000..08c1c55e8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.5.5" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.5.5-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.5.5-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.5.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.7/.env b/linux/ecosystem/atlassian/crowd/2/2.5.7/.env new file mode 100644 index 000000000..297b2f00d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.7/.env @@ -0,0 +1,3 @@ +RELEASE=2.5.7 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.7/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.5.7/Dockerfile new file mode 100644 index 000000000..1e5ec0a5f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.7/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.5.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.7/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.5.7/Dockerfile.jdk7 new file mode 100644 index 000000000..9ca8e3b82 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.7/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.5.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.7/Makefile b/linux/ecosystem/atlassian/crowd/2/2.5.7/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.7/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.7/README.md b/linux/ecosystem/atlassian/crowd/2/2.5.7/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.7/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.7/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.5.7/docker-compose.yml new file mode 100644 index 000000000..c44bbf95c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.7/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.5.7" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.5.7-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.5.7-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.5.7/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.5.7/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.5.7/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.0/.env b/linux/ecosystem/atlassian/crowd/2/2.6.0/.env new file mode 100644 index 000000000..c294dc986 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.0/.env @@ -0,0 +1,3 @@ +RELEASE=2.6.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.0/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.6.0/Dockerfile new file mode 100644 index 000000000..399b91364 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.0/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.6.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.6.0/Dockerfile.jdk7 new file mode 100644 index 000000000..5367ad8f0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.0/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.6.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.0/Makefile b/linux/ecosystem/atlassian/crowd/2/2.6.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.0/README.md b/linux/ecosystem/atlassian/crowd/2/2.6.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.6.0/docker-compose.yml new file mode 100644 index 000000000..cc8c820fa --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.6.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.6.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.6.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.6.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.1/.env b/linux/ecosystem/atlassian/crowd/2/2.6.1/.env new file mode 100644 index 000000000..57b4d37b5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.1/.env @@ -0,0 +1,3 @@ +RELEASE=2.6.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.1/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.6.1/Dockerfile new file mode 100644 index 000000000..fc6c44410 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.1/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.6.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.6.1/Dockerfile.jdk7 new file mode 100644 index 000000000..16a7dbcff --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.1/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.6.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.1/Makefile b/linux/ecosystem/atlassian/crowd/2/2.6.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.1/README.md b/linux/ecosystem/atlassian/crowd/2/2.6.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.6.1/docker-compose.yml new file mode 100644 index 000000000..436292efa --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.6.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.6.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.6.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.6.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.2/.env b/linux/ecosystem/atlassian/crowd/2/2.6.2/.env new file mode 100644 index 000000000..84c95bd22 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.2/.env @@ -0,0 +1,3 @@ +RELEASE=2.6.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.2/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.6.2/Dockerfile new file mode 100644 index 000000000..6d3d2e9bf --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.6.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.6.2/Dockerfile.jdk7 new file mode 100644 index 000000000..80713c417 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.2/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.6.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.2/Makefile b/linux/ecosystem/atlassian/crowd/2/2.6.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.2/README.md b/linux/ecosystem/atlassian/crowd/2/2.6.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.6.2/docker-compose.yml new file mode 100644 index 000000000..db2aa3054 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.6.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.6.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.6.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.6.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.3/.env b/linux/ecosystem/atlassian/crowd/2/2.6.3/.env new file mode 100644 index 000000000..60deb5d40 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.3/.env @@ -0,0 +1,3 @@ +RELEASE=2.6.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.3/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.6.3/Dockerfile new file mode 100644 index 000000000..0a7d541e8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.3/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.6.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.6.3/Dockerfile.jdk7 new file mode 100644 index 000000000..0510cf9f8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.3/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.6.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.3/Makefile b/linux/ecosystem/atlassian/crowd/2/2.6.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.3/README.md b/linux/ecosystem/atlassian/crowd/2/2.6.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.6.3/docker-compose.yml new file mode 100644 index 000000000..a3e63bbab --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.6.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.6.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.6.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.6.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.4/.env b/linux/ecosystem/atlassian/crowd/2/2.6.4/.env new file mode 100644 index 000000000..9594b785a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.4/.env @@ -0,0 +1,3 @@ +RELEASE=2.6.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.4/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.6.4/Dockerfile new file mode 100644 index 000000000..88bfca9f8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.4/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.6.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.4/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.6.4/Dockerfile.jdk7 new file mode 100644 index 000000000..8a65dcd28 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.4/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.6.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.4/Makefile b/linux/ecosystem/atlassian/crowd/2/2.6.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.4/README.md b/linux/ecosystem/atlassian/crowd/2/2.6.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.6.4/docker-compose.yml new file mode 100644 index 000000000..26586426c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.6.4" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.6.4-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.6.4-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.6.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.5/.env b/linux/ecosystem/atlassian/crowd/2/2.6.5/.env new file mode 100644 index 000000000..86a3ed2ba --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.5/.env @@ -0,0 +1,3 @@ +RELEASE=2.6.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.5/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.6.5/Dockerfile new file mode 100644 index 000000000..a38d01e82 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.5/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.6.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.5/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.6.5/Dockerfile.jdk7 new file mode 100644 index 000000000..84df6a24d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.5/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.6.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.5/Makefile b/linux/ecosystem/atlassian/crowd/2/2.6.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.5/README.md b/linux/ecosystem/atlassian/crowd/2/2.6.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.6.5/docker-compose.yml new file mode 100644 index 000000000..fb2a86dd4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.6.5" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.6.5-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.6.5-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.6.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.7/.env b/linux/ecosystem/atlassian/crowd/2/2.6.7/.env new file mode 100644 index 000000000..3abf64b87 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.7/.env @@ -0,0 +1,3 @@ +RELEASE=2.6.7 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.7/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.6.7/Dockerfile new file mode 100644 index 000000000..e6a9338f6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.7/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.6.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.7/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.6.7/Dockerfile.jdk7 new file mode 100644 index 000000000..7b8b16ef9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.7/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.6.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.7/Makefile b/linux/ecosystem/atlassian/crowd/2/2.6.7/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.7/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.7/README.md b/linux/ecosystem/atlassian/crowd/2/2.6.7/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.7/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.7/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.6.7/docker-compose.yml new file mode 100644 index 000000000..dc73e44fb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.7/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.6.7" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.6.7-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.6.7-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.6.7/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.6.7/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.6.7/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.0/.env b/linux/ecosystem/atlassian/crowd/2/2.7.0/.env new file mode 100644 index 000000000..337ddb7f3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.0/.env @@ -0,0 +1,3 @@ +RELEASE=2.7.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.0/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.7.0/Dockerfile new file mode 100644 index 000000000..42fff7a8a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.0/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.7.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.7.0/Dockerfile.jdk7 new file mode 100644 index 000000000..257119aeb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.0/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.7.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.0/Makefile b/linux/ecosystem/atlassian/crowd/2/2.7.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.0/README.md b/linux/ecosystem/atlassian/crowd/2/2.7.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.7.0/docker-compose.yml new file mode 100644 index 000000000..fa21f2694 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.7.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.7.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.7.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.7.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.1/.env b/linux/ecosystem/atlassian/crowd/2/2.7.1/.env new file mode 100644 index 000000000..2fb447f68 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.1/.env @@ -0,0 +1,3 @@ +RELEASE=2.7.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.1/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.7.1/Dockerfile new file mode 100644 index 000000000..dc0054e58 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.1/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.7.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.7.1/Dockerfile.jdk7 new file mode 100644 index 000000000..a200de4bb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.1/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.7.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.1/Makefile b/linux/ecosystem/atlassian/crowd/2/2.7.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.1/README.md b/linux/ecosystem/atlassian/crowd/2/2.7.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.7.1/docker-compose.yml new file mode 100644 index 000000000..228e56192 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.7.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.7.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.7.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.7.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.2/.env b/linux/ecosystem/atlassian/crowd/2/2.7.2/.env new file mode 100644 index 000000000..c9e4a5b8e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.2/.env @@ -0,0 +1,3 @@ +RELEASE=2.7.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.2/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.7.2/Dockerfile new file mode 100644 index 000000000..066ac2da2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.7.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.7.2/Dockerfile.jdk7 new file mode 100644 index 000000000..d257740c7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.2/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.7.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.2/Makefile b/linux/ecosystem/atlassian/crowd/2/2.7.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.2/README.md b/linux/ecosystem/atlassian/crowd/2/2.7.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.7.2/docker-compose.yml new file mode 100644 index 000000000..fc8e7a99b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.7.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.7.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.7.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.7.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.7.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.7.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.0/.env b/linux/ecosystem/atlassian/crowd/2/2.8.0/.env new file mode 100644 index 000000000..542df868e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.0/.env @@ -0,0 +1,3 @@ +RELEASE=2.8.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.0/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.8.0/Dockerfile new file mode 100644 index 000000000..cc2ca0578 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.0/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.8.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.8.0/Dockerfile.jdk7 new file mode 100644 index 000000000..e3693944d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.0/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.8.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.0/Makefile b/linux/ecosystem/atlassian/crowd/2/2.8.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.0/README.md b/linux/ecosystem/atlassian/crowd/2/2.8.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.8.0/docker-compose.yml new file mode 100644 index 000000000..d8c893761 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.8.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.8.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.8.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.8.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.2/.env b/linux/ecosystem/atlassian/crowd/2/2.8.2/.env new file mode 100644 index 000000000..44ba99ad2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.2/.env @@ -0,0 +1,3 @@ +RELEASE=2.8.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.2/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.8.2/Dockerfile new file mode 100644 index 000000000..a0de23d02 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.2/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.8.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.8.2/Dockerfile.jdk7 new file mode 100644 index 000000000..0e2b50586 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.2/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.8.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.2/Makefile b/linux/ecosystem/atlassian/crowd/2/2.8.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.2/README.md b/linux/ecosystem/atlassian/crowd/2/2.8.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.8.2/docker-compose.yml new file mode 100644 index 000000000..a8baea12e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.8.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.8.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.8.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.8.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.3/.env b/linux/ecosystem/atlassian/crowd/2/2.8.3/.env new file mode 100644 index 000000000..d178b2a41 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.3/.env @@ -0,0 +1,3 @@ +RELEASE=2.8.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.3/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.8.3/Dockerfile new file mode 100644 index 000000000..8887881b8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.3/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.8.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.8.3/Dockerfile.jdk7 new file mode 100644 index 000000000..4649548a9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.3/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.8.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.3/Makefile b/linux/ecosystem/atlassian/crowd/2/2.8.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.3/README.md b/linux/ecosystem/atlassian/crowd/2/2.8.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.8.3/docker-compose.yml new file mode 100644 index 000000000..8352d0b19 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.8.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.8.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.8.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.8.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.4/.env b/linux/ecosystem/atlassian/crowd/2/2.8.4/.env new file mode 100644 index 000000000..5c144f436 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.4/.env @@ -0,0 +1,3 @@ +RELEASE=2.8.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.4/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.8.4/Dockerfile new file mode 100644 index 000000000..bfdbd2742 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.4/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.8.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.4/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.8.4/Dockerfile.jdk7 new file mode 100644 index 000000000..d80f724c0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.4/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.8.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.4/Makefile b/linux/ecosystem/atlassian/crowd/2/2.8.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.4/README.md b/linux/ecosystem/atlassian/crowd/2/2.8.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.8.4/docker-compose.yml new file mode 100644 index 000000000..27a769ff3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.8.4" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.8.4-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.8.4-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.8.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.8/.env b/linux/ecosystem/atlassian/crowd/2/2.8.8/.env new file mode 100644 index 000000000..ddd055265 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.8/.env @@ -0,0 +1,3 @@ +RELEASE=2.8.8 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.8/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.8.8/Dockerfile new file mode 100644 index 000000000..6f0709d1e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.8/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.8.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.8/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.8.8/Dockerfile.jdk7 new file mode 100644 index 000000000..74a15627c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.8/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.8.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.8/Makefile b/linux/ecosystem/atlassian/crowd/2/2.8.8/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.8/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.8/README.md b/linux/ecosystem/atlassian/crowd/2/2.8.8/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.8/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.8/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.8.8/docker-compose.yml new file mode 100644 index 000000000..d529bdaa4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.8/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.8.8" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.8.8-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.8.8-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.8.8/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.8.8/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.8.8/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.1/.env b/linux/ecosystem/atlassian/crowd/2/2.9.1/.env new file mode 100644 index 000000000..368bc56a1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.1/.env @@ -0,0 +1,3 @@ +RELEASE=2.9.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.1/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.9.1/Dockerfile new file mode 100644 index 000000000..6b9548c58 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.1/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.9.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.9.1/Dockerfile.jdk7 new file mode 100644 index 000000000..d284f8bc6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.1/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.9.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.1/Makefile b/linux/ecosystem/atlassian/crowd/2/2.9.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.1/README.md b/linux/ecosystem/atlassian/crowd/2/2.9.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.9.1/docker-compose.yml new file mode 100644 index 000000000..5ad0566e0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.9.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.9.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.9.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.9.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.5/.env b/linux/ecosystem/atlassian/crowd/2/2.9.5/.env new file mode 100644 index 000000000..628805f06 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.5/.env @@ -0,0 +1,3 @@ +RELEASE=2.9.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.5/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.9.5/Dockerfile new file mode 100644 index 000000000..30b80ad5a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.5/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.9.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.5/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.9.5/Dockerfile.jdk7 new file mode 100644 index 000000000..2293fe9aa --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.5/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.9.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.5/Makefile b/linux/ecosystem/atlassian/crowd/2/2.9.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.5/README.md b/linux/ecosystem/atlassian/crowd/2/2.9.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.9.5/docker-compose.yml new file mode 100644 index 000000000..753600004 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.9.5" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.9.5-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.9.5-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.9.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.7/.env b/linux/ecosystem/atlassian/crowd/2/2.9.7/.env new file mode 100644 index 000000000..ce47c2aa1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.7/.env @@ -0,0 +1,3 @@ +RELEASE=2.9.7 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.7/Dockerfile b/linux/ecosystem/atlassian/crowd/2/2.9.7/Dockerfile new file mode 100644 index 000000000..e420ee78f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.7/Dockerfile @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.9.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.7/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/2/2.9.7/Dockerfile.jdk7 new file mode 100644 index 000000000..1944a30df --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.7/Dockerfile.jdk7 @@ -0,0 +1,87 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=2.9.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e '2s/^exec/cd "`dirname "$0"`" \&\& exec/' ${CROWD_INSTALL_DIR}/start_crowd.sh && \ + sed -i -e 's#exec "$PRGDIR"/"$EXECUTABLE" start "$@"#exec "$PRGDIR"/"$EXECUTABLE" run "$@"#g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/startup.sh && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.7/Makefile b/linux/ecosystem/atlassian/crowd/2/2.9.7/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.7/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.7/README.md b/linux/ecosystem/atlassian/crowd/2/2.9.7/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.7/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.7/docker-compose.yml b/linux/ecosystem/atlassian/crowd/2/2.9.7/docker-compose.yml new file mode 100644 index 000000000..965fd1cef --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.7/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:2.9.7" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:2.9.7-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:2.9.7-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/2/2.9.7/entrypoint.sh b/linux/ecosystem/atlassian/crowd/2/2.9.7/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/2/2.9.7/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.0/.env b/linux/ecosystem/atlassian/crowd/3/3.0.0/.env new file mode 100644 index 000000000..11c149088 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.0/.env @@ -0,0 +1,3 @@ +RELEASE=3.0.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.0/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.0.0/Dockerfile new file mode 100644 index 000000000..d5abc85b0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.0.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.0.0/Dockerfile.jdk7 new file mode 100644 index 000000000..53c776e21 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.0/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.0.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.0/Makefile b/linux/ecosystem/atlassian/crowd/3/3.0.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.0/README.md b/linux/ecosystem/atlassian/crowd/3/3.0.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.0.0/docker-compose.yml new file mode 100644 index 000000000..4aa3d78e1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.0.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.0.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.0.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.0.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.1/.env b/linux/ecosystem/atlassian/crowd/3/3.0.1/.env new file mode 100644 index 000000000..d91e9eb0b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.1/.env @@ -0,0 +1,3 @@ +RELEASE=3.0.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.1/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.0.1/Dockerfile new file mode 100644 index 000000000..1321c414f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.1/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.0.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.0.1/Dockerfile.jdk7 new file mode 100644 index 000000000..6df484159 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.1/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.0.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.1/Makefile b/linux/ecosystem/atlassian/crowd/3/3.0.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.1/README.md b/linux/ecosystem/atlassian/crowd/3/3.0.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.0.1/docker-compose.yml new file mode 100644 index 000000000..ab09b365b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.0.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.0.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.0.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.0.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.2/.env b/linux/ecosystem/atlassian/crowd/3/3.0.2/.env new file mode 100644 index 000000000..7e93fc6e4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.2/.env @@ -0,0 +1,3 @@ +RELEASE=3.0.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.2/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.0.2/Dockerfile new file mode 100644 index 000000000..20182c049 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.0.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.0.2/Dockerfile.jdk7 new file mode 100644 index 000000000..69848b04c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.2/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.0.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.2/Makefile b/linux/ecosystem/atlassian/crowd/3/3.0.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.2/README.md b/linux/ecosystem/atlassian/crowd/3/3.0.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.0.2/docker-compose.yml new file mode 100644 index 000000000..4caefa745 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.0.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.0.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.0.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.0.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.3/.env b/linux/ecosystem/atlassian/crowd/3/3.0.3/.env new file mode 100644 index 000000000..751cd0035 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.3/.env @@ -0,0 +1,3 @@ +RELEASE=3.0.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.3/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.0.3/Dockerfile new file mode 100644 index 000000000..82a6eb5d1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.0.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.0.3/Dockerfile.jdk7 new file mode 100644 index 000000000..010a8100d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.3/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.0.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.3/Makefile b/linux/ecosystem/atlassian/crowd/3/3.0.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.3/README.md b/linux/ecosystem/atlassian/crowd/3/3.0.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.0.3/docker-compose.yml new file mode 100644 index 000000000..eab1ac337 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.0.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.0.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.0.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.0.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.5/.env b/linux/ecosystem/atlassian/crowd/3/3.0.5/.env new file mode 100644 index 000000000..2641df162 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.5/.env @@ -0,0 +1,3 @@ +RELEASE=3.0.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.5/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.0.5/Dockerfile new file mode 100644 index 000000000..286133f8c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.5/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.0.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.5/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.0.5/Dockerfile.jdk7 new file mode 100644 index 000000000..37ca1af28 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.5/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.0.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.5/Makefile b/linux/ecosystem/atlassian/crowd/3/3.0.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.5/README.md b/linux/ecosystem/atlassian/crowd/3/3.0.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.0.5/docker-compose.yml new file mode 100644 index 000000000..9b4c1f287 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.0.5" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.0.5-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.0.5-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.0.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.0.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.0.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.1/.env b/linux/ecosystem/atlassian/crowd/3/3.1.1/.env new file mode 100644 index 000000000..b24e98bc9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.1/.env @@ -0,0 +1,3 @@ +RELEASE=3.1.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.1/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.1.1/Dockerfile new file mode 100644 index 000000000..319f6fc8b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.1/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.1.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.1.1/Dockerfile.jdk7 new file mode 100644 index 000000000..bab410feb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.1/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.1.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.1/Makefile b/linux/ecosystem/atlassian/crowd/3/3.1.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.1/README.md b/linux/ecosystem/atlassian/crowd/3/3.1.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.1.1/docker-compose.yml new file mode 100644 index 000000000..6a079743a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.1.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.1.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.1.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.1.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.2/.env b/linux/ecosystem/atlassian/crowd/3/3.1.2/.env new file mode 100644 index 000000000..cc2bce5a0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.2/.env @@ -0,0 +1,3 @@ +RELEASE=3.1.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.2/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.1.2/Dockerfile new file mode 100644 index 000000000..957178c75 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.1.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.1.2/Dockerfile.jdk7 new file mode 100644 index 000000000..40b04dfc1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.2/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.1.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.2/Makefile b/linux/ecosystem/atlassian/crowd/3/3.1.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.2/README.md b/linux/ecosystem/atlassian/crowd/3/3.1.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.1.2/docker-compose.yml new file mode 100644 index 000000000..9e42b6404 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.1.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.1.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.1.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.1.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.3/.env b/linux/ecosystem/atlassian/crowd/3/3.1.3/.env new file mode 100644 index 000000000..21e76a6fa --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.3/.env @@ -0,0 +1,3 @@ +RELEASE=3.1.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.3/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.1.3/Dockerfile new file mode 100644 index 000000000..d6e11e349 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.1.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.1.3/Dockerfile.jdk7 new file mode 100644 index 000000000..896814df5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.3/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.1.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.3/Makefile b/linux/ecosystem/atlassian/crowd/3/3.1.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.3/README.md b/linux/ecosystem/atlassian/crowd/3/3.1.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.1.3/docker-compose.yml new file mode 100644 index 000000000..4bf747850 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.1.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.1.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.1.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.1.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.4/.env b/linux/ecosystem/atlassian/crowd/3/3.1.4/.env new file mode 100644 index 000000000..f12d4fdc9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.4/.env @@ -0,0 +1,3 @@ +RELEASE=3.1.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.4/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.1.4/Dockerfile new file mode 100644 index 000000000..094d9ce8f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.4/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.1.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.4/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.1.4/Dockerfile.jdk7 new file mode 100644 index 000000000..755af9e36 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.4/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.1.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.4/Makefile b/linux/ecosystem/atlassian/crowd/3/3.1.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.4/README.md b/linux/ecosystem/atlassian/crowd/3/3.1.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.1.4/docker-compose.yml new file mode 100644 index 000000000..b7763543e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.1.4" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.1.4-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.1.4-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.1.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.5/.env b/linux/ecosystem/atlassian/crowd/3/3.1.5/.env new file mode 100644 index 000000000..377d5c66c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.5/.env @@ -0,0 +1,3 @@ +RELEASE=3.1.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.5/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.1.5/Dockerfile new file mode 100644 index 000000000..82b9c53cb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.5/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.1.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.5/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.1.5/Dockerfile.jdk7 new file mode 100644 index 000000000..6c2cb11b2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.5/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.1.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.5/Makefile b/linux/ecosystem/atlassian/crowd/3/3.1.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.5/README.md b/linux/ecosystem/atlassian/crowd/3/3.1.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.1.5/docker-compose.yml new file mode 100644 index 000000000..a788e7910 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.1.5" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.1.5-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.1.5-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.1.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.6/.env b/linux/ecosystem/atlassian/crowd/3/3.1.6/.env new file mode 100644 index 000000000..7ed844432 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.6/.env @@ -0,0 +1,3 @@ +RELEASE=3.1.6 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.6/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.1.6/Dockerfile new file mode 100644 index 000000000..a8e8dbcce --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.6/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.1.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.6/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.1.6/Dockerfile.jdk7 new file mode 100644 index 000000000..531354657 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.6/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.1.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.6/Makefile b/linux/ecosystem/atlassian/crowd/3/3.1.6/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.6/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.6/README.md b/linux/ecosystem/atlassian/crowd/3/3.1.6/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.6/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.6/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.1.6/docker-compose.yml new file mode 100644 index 000000000..c638a1600 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.6/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.1.6" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.1.6-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.1.6-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.1.6/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.1.6/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.1.6/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.0/.env b/linux/ecosystem/atlassian/crowd/3/3.2.0/.env new file mode 100644 index 000000000..91d5650f4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.0/.env @@ -0,0 +1,3 @@ +RELEASE=3.2.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.0/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.2.0/Dockerfile new file mode 100644 index 000000000..2b59e5eaf --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.2.0/Dockerfile.jdk7 new file mode 100644 index 000000000..6a291e076 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.0/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.0/Makefile b/linux/ecosystem/atlassian/crowd/3/3.2.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.0/README.md b/linux/ecosystem/atlassian/crowd/3/3.2.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.2.0/docker-compose.yml new file mode 100644 index 000000000..f0807ec82 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.2.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.2.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.2.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.2.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.1/.env b/linux/ecosystem/atlassian/crowd/3/3.2.1/.env new file mode 100644 index 000000000..ee0932b80 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.1/.env @@ -0,0 +1,3 @@ +RELEASE=3.2.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.1/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.2.1/Dockerfile new file mode 100644 index 000000000..256026715 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.1/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.2.1/Dockerfile.jdk7 new file mode 100644 index 000000000..e50eda90b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.1/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.1/Makefile b/linux/ecosystem/atlassian/crowd/3/3.2.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.1/README.md b/linux/ecosystem/atlassian/crowd/3/3.2.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.2.1/docker-compose.yml new file mode 100644 index 000000000..79557fe64 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.2.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.2.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.2.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.2.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.11/.env b/linux/ecosystem/atlassian/crowd/3/3.2.11/.env new file mode 100644 index 000000000..21da8200b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.11/.env @@ -0,0 +1,3 @@ +RELEASE=3.2.11 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.11/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.2.11/Dockerfile new file mode 100644 index 000000000..032242ad4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.11/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.11 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.11/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.2.11/Dockerfile.jdk7 new file mode 100644 index 000000000..2f2b4a861 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.11/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.11 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.11/Makefile b/linux/ecosystem/atlassian/crowd/3/3.2.11/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.11/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.11/README.md b/linux/ecosystem/atlassian/crowd/3/3.2.11/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.11/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.11/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.2.11/docker-compose.yml new file mode 100644 index 000000000..530928baa --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.11/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.2.11" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.2.11-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.2.11-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.11/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.2.11/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.11/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.2/.env b/linux/ecosystem/atlassian/crowd/3/3.2.2/.env new file mode 100644 index 000000000..2ad8edcc9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.2/.env @@ -0,0 +1,3 @@ +RELEASE=3.2.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.2/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.2.2/Dockerfile new file mode 100644 index 000000000..3ca3058d2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.2.2/Dockerfile.jdk7 new file mode 100644 index 000000000..439a7820c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.2/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.2/Makefile b/linux/ecosystem/atlassian/crowd/3/3.2.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.2/README.md b/linux/ecosystem/atlassian/crowd/3/3.2.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.2.2/docker-compose.yml new file mode 100644 index 000000000..3571eaa6a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.2.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.2.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.2.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.2.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.3/.env b/linux/ecosystem/atlassian/crowd/3/3.2.3/.env new file mode 100644 index 000000000..f6ae29f60 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.3/.env @@ -0,0 +1,3 @@ +RELEASE=3.2.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.3/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.2.3/Dockerfile new file mode 100644 index 000000000..d062b968b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.2.3/Dockerfile.jdk7 new file mode 100644 index 000000000..a723b94b9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.3/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.3/Makefile b/linux/ecosystem/atlassian/crowd/3/3.2.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.3/README.md b/linux/ecosystem/atlassian/crowd/3/3.2.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.2.3/docker-compose.yml new file mode 100644 index 000000000..e38d850ae --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.2.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.2.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.2.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.2.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.5/.env b/linux/ecosystem/atlassian/crowd/3/3.2.5/.env new file mode 100644 index 000000000..f0f6051ec --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.5/.env @@ -0,0 +1,3 @@ +RELEASE=3.2.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.5/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.2.5/Dockerfile new file mode 100644 index 000000000..b569ecd23 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.5/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.5/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.2.5/Dockerfile.jdk7 new file mode 100644 index 000000000..56ce2a8d7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.5/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.5/Makefile b/linux/ecosystem/atlassian/crowd/3/3.2.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.5/README.md b/linux/ecosystem/atlassian/crowd/3/3.2.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.2.5/docker-compose.yml new file mode 100644 index 000000000..b521ee719 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.2.5" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.2.5-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.2.5-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.2.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.6/.env b/linux/ecosystem/atlassian/crowd/3/3.2.6/.env new file mode 100644 index 000000000..44078bfcf --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.6/.env @@ -0,0 +1,3 @@ +RELEASE=3.2.6 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.6/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.2.6/Dockerfile new file mode 100644 index 000000000..b8e27456c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.6/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.6/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.2.6/Dockerfile.jdk7 new file mode 100644 index 000000000..1e259d4c7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.6/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.6/Makefile b/linux/ecosystem/atlassian/crowd/3/3.2.6/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.6/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.6/README.md b/linux/ecosystem/atlassian/crowd/3/3.2.6/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.6/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.6/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.2.6/docker-compose.yml new file mode 100644 index 000000000..647bad159 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.6/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.2.6" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.2.6-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.2.6-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.6/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.2.6/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.6/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.7/.env b/linux/ecosystem/atlassian/crowd/3/3.2.7/.env new file mode 100644 index 000000000..691af90c8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.7/.env @@ -0,0 +1,3 @@ +RELEASE=3.2.7 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.7/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.2.7/Dockerfile new file mode 100644 index 000000000..c0fd1dd2e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.7/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.7/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.2.7/Dockerfile.jdk7 new file mode 100644 index 000000000..de9326a27 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.7/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.7/Makefile b/linux/ecosystem/atlassian/crowd/3/3.2.7/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.7/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.7/README.md b/linux/ecosystem/atlassian/crowd/3/3.2.7/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.7/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.7/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.2.7/docker-compose.yml new file mode 100644 index 000000000..2b8faee16 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.7/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.2.7" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.2.7-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.2.7-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.7/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.2.7/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.7/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.8/.env b/linux/ecosystem/atlassian/crowd/3/3.2.8/.env new file mode 100644 index 000000000..44e462047 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.8/.env @@ -0,0 +1,3 @@ +RELEASE=3.2.8 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.8/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.2.8/Dockerfile new file mode 100644 index 000000000..2cae90d88 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.8/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.8/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.2.8/Dockerfile.jdk7 new file mode 100644 index 000000000..b7d4b8a0e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.8/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.2.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.8/Makefile b/linux/ecosystem/atlassian/crowd/3/3.2.8/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.8/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.8/README.md b/linux/ecosystem/atlassian/crowd/3/3.2.8/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.8/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.8/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.2.8/docker-compose.yml new file mode 100644 index 000000000..f047f9b35 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.8/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.2.8" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.2.8-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.2.8-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.2.8/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.2.8/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.2.8/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.0/.env b/linux/ecosystem/atlassian/crowd/3/3.3.0/.env new file mode 100644 index 000000000..2c4727821 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.0/.env @@ -0,0 +1,3 @@ +RELEASE=3.3.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.0/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.3.0/Dockerfile new file mode 100644 index 000000000..283f8fa6a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.3.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.3.0/Dockerfile.jdk7 new file mode 100644 index 000000000..e6417d840 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.0/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.3.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.0/Makefile b/linux/ecosystem/atlassian/crowd/3/3.3.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.0/README.md b/linux/ecosystem/atlassian/crowd/3/3.3.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.3.0/docker-compose.yml new file mode 100644 index 000000000..563a750d7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.3.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.3.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.3.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.3.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.2/.env b/linux/ecosystem/atlassian/crowd/3/3.3.2/.env new file mode 100644 index 000000000..4532f43bd --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.2/.env @@ -0,0 +1,3 @@ +RELEASE=3.3.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.2/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.3.2/Dockerfile new file mode 100644 index 000000000..136b3a1dc --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.3.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.3.2/Dockerfile.jdk7 new file mode 100644 index 000000000..6b98c1f8b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.2/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.3.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.2/Makefile b/linux/ecosystem/atlassian/crowd/3/3.3.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.2/README.md b/linux/ecosystem/atlassian/crowd/3/3.3.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.3.2/docker-compose.yml new file mode 100644 index 000000000..ad08a5953 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.3.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.3.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.3.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.3.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.3/.env b/linux/ecosystem/atlassian/crowd/3/3.3.3/.env new file mode 100644 index 000000000..3dec75964 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.3/.env @@ -0,0 +1,3 @@ +RELEASE=3.3.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.3/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.3.3/Dockerfile new file mode 100644 index 000000000..f07fe4919 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.3.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.3.3/Dockerfile.jdk7 new file mode 100644 index 000000000..98cf00ae5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.3/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.3.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.3/Makefile b/linux/ecosystem/atlassian/crowd/3/3.3.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.3/README.md b/linux/ecosystem/atlassian/crowd/3/3.3.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.3.3/docker-compose.yml new file mode 100644 index 000000000..7cf6725d0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.3.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.3.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.3.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.3.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.4/.env b/linux/ecosystem/atlassian/crowd/3/3.3.4/.env new file mode 100644 index 000000000..b26234929 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.4/.env @@ -0,0 +1,3 @@ +RELEASE=3.3.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.4/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.3.4/Dockerfile new file mode 100644 index 000000000..0e1222a49 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.4/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.3.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.4/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.3.4/Dockerfile.jdk7 new file mode 100644 index 000000000..bd9af339b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.4/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.3.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.4/Makefile b/linux/ecosystem/atlassian/crowd/3/3.3.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.4/README.md b/linux/ecosystem/atlassian/crowd/3/3.3.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.3.4/docker-compose.yml new file mode 100644 index 000000000..2ca8bc25d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.3.4" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.3.4-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.3.4-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.3.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.5/.env b/linux/ecosystem/atlassian/crowd/3/3.3.5/.env new file mode 100644 index 000000000..0c3e62e6a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.5/.env @@ -0,0 +1,3 @@ +RELEASE=3.3.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.5/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.3.5/Dockerfile new file mode 100644 index 000000000..5568632fb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.5/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.3.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.5/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.3.5/Dockerfile.jdk7 new file mode 100644 index 000000000..57d72cdfa --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.5/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.3.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.5/Makefile b/linux/ecosystem/atlassian/crowd/3/3.3.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.5/README.md b/linux/ecosystem/atlassian/crowd/3/3.3.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.3.5/docker-compose.yml new file mode 100644 index 000000000..d6e0b5d61 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.3.5" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.3.5-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.3.5-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.3.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.6/.env b/linux/ecosystem/atlassian/crowd/3/3.3.6/.env new file mode 100644 index 000000000..7a9e976b2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.6/.env @@ -0,0 +1,3 @@ +RELEASE=3.3.6 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.6/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.3.6/Dockerfile new file mode 100644 index 000000000..59f4a522d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.6/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.3.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.6/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.3.6/Dockerfile.jdk7 new file mode 100644 index 000000000..f385a7dbd --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.6/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.3.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.6/Makefile b/linux/ecosystem/atlassian/crowd/3/3.3.6/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.6/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.6/README.md b/linux/ecosystem/atlassian/crowd/3/3.3.6/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.6/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.6/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.3.6/docker-compose.yml new file mode 100644 index 000000000..407d3acaf --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.6/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.3.6" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.3.6-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.3.6-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.6/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.3.6/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.6/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.7/.env b/linux/ecosystem/atlassian/crowd/3/3.3.7/.env new file mode 100644 index 000000000..9bd86875a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.7/.env @@ -0,0 +1,3 @@ +RELEASE=3.3.7 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.7/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.3.7/Dockerfile new file mode 100644 index 000000000..41fd6ddf8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.7/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.3.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.7/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.3.7/Dockerfile.jdk7 new file mode 100644 index 000000000..5b51307c9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.7/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.3.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.7/Makefile b/linux/ecosystem/atlassian/crowd/3/3.3.7/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.7/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.7/README.md b/linux/ecosystem/atlassian/crowd/3/3.3.7/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.7/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.7/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.3.7/docker-compose.yml new file mode 100644 index 000000000..86765ba5f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.7/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.3.7" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.3.7-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.3.7-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.3.7/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.3.7/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.3.7/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.0/.env b/linux/ecosystem/atlassian/crowd/3/3.4.0/.env new file mode 100644 index 000000000..a3dbeb8e3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.0/.env @@ -0,0 +1,3 @@ +RELEASE=3.4.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.0/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.4.0/Dockerfile new file mode 100644 index 000000000..4fe01308b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.4.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.4.0/Dockerfile.jdk7 new file mode 100644 index 000000000..c9270159c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.0/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.4.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.0/Makefile b/linux/ecosystem/atlassian/crowd/3/3.4.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.0/README.md b/linux/ecosystem/atlassian/crowd/3/3.4.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.4.0/docker-compose.yml new file mode 100644 index 000000000..7c2d7b764 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.4.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.4.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.4.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.4.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.3/.env b/linux/ecosystem/atlassian/crowd/3/3.4.3/.env new file mode 100644 index 000000000..93be1e566 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.3/.env @@ -0,0 +1,3 @@ +RELEASE=3.4.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.3/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.4.3/Dockerfile new file mode 100644 index 000000000..bbcf6224e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.4.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.3/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.4.3/Dockerfile.jdk7 new file mode 100644 index 000000000..7869a4c85 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.3/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.4.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.3/Makefile b/linux/ecosystem/atlassian/crowd/3/3.4.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.3/README.md b/linux/ecosystem/atlassian/crowd/3/3.4.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.4.3/docker-compose.yml new file mode 100644 index 000000000..c2f93ef95 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.4.3" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.4.3-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.4.3-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.4.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.4/.env b/linux/ecosystem/atlassian/crowd/3/3.4.4/.env new file mode 100644 index 000000000..e8dbeb755 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.4/.env @@ -0,0 +1,3 @@ +RELEASE=3.4.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.4/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.4.4/Dockerfile new file mode 100644 index 000000000..44222f0cd --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.4/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.4.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.4/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.4.4/Dockerfile.jdk7 new file mode 100644 index 000000000..f22bb8462 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.4/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.4.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.4/Makefile b/linux/ecosystem/atlassian/crowd/3/3.4.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.4/README.md b/linux/ecosystem/atlassian/crowd/3/3.4.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.4.4/docker-compose.yml new file mode 100644 index 000000000..72b41d4db --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.4.4" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.4.4-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.4.4-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.4.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.5/.env b/linux/ecosystem/atlassian/crowd/3/3.4.5/.env new file mode 100644 index 000000000..e0c6741f1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.5/.env @@ -0,0 +1,3 @@ +RELEASE=3.4.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.5/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.4.5/Dockerfile new file mode 100644 index 000000000..d682655a9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.5/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.4.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.5/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.4.5/Dockerfile.jdk7 new file mode 100644 index 000000000..d66e694e5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.5/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.4.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.5/Makefile b/linux/ecosystem/atlassian/crowd/3/3.4.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.5/README.md b/linux/ecosystem/atlassian/crowd/3/3.4.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.4.5/docker-compose.yml new file mode 100644 index 000000000..1f116da62 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.4.5" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.4.5-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.4.5-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.4.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.6/.env b/linux/ecosystem/atlassian/crowd/3/3.4.6/.env new file mode 100644 index 000000000..d26f66516 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.6/.env @@ -0,0 +1,3 @@ +RELEASE=3.4.6 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.6/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.4.6/Dockerfile new file mode 100644 index 000000000..5a63a5ff5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.6/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.4.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.6/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.4.6/Dockerfile.jdk7 new file mode 100644 index 000000000..472cda194 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.6/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.4.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.6/Makefile b/linux/ecosystem/atlassian/crowd/3/3.4.6/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.6/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.6/README.md b/linux/ecosystem/atlassian/crowd/3/3.4.6/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.6/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.6/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.4.6/docker-compose.yml new file mode 100644 index 000000000..4b1a42076 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.6/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.4.6" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.4.6-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.4.6-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.4.6/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.4.6/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.4.6/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.5.0/.env b/linux/ecosystem/atlassian/crowd/3/3.5.0/.env new file mode 100644 index 000000000..48b063653 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.5.0/.env @@ -0,0 +1,3 @@ +RELEASE=3.5.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.5.0/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.5.0/Dockerfile new file mode 100644 index 000000000..510d500a4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.5.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.5.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.5.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.5.0/Dockerfile.jdk7 new file mode 100644 index 000000000..c5f1b173a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.5.0/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.5.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.5.0/Makefile b/linux/ecosystem/atlassian/crowd/3/3.5.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.5.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.5.0/README.md b/linux/ecosystem/atlassian/crowd/3/3.5.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.5.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.5.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.5.0/docker-compose.yml new file mode 100644 index 000000000..a641bf9db --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.5.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.5.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.5.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.5.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.5.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.5.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.5.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.5.1/.env b/linux/ecosystem/atlassian/crowd/3/3.5.1/.env new file mode 100644 index 000000000..186510988 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.5.1/.env @@ -0,0 +1,3 @@ +RELEASE=3.5.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.5.1/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.5.1/Dockerfile new file mode 100644 index 000000000..b225419bc --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.5.1/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.5.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.5.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.5.1/Dockerfile.jdk7 new file mode 100644 index 000000000..5a0388b35 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.5.1/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.5.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.5.1/Makefile b/linux/ecosystem/atlassian/crowd/3/3.5.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.5.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.5.1/README.md b/linux/ecosystem/atlassian/crowd/3/3.5.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.5.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.5.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.5.1/docker-compose.yml new file mode 100644 index 000000000..0b17a23a5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.5.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.5.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.5.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.5.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.5.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.5.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.5.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.6.0/.env b/linux/ecosystem/atlassian/crowd/3/3.6.0/.env new file mode 100644 index 000000000..662f0946c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.6.0/.env @@ -0,0 +1,3 @@ +RELEASE=3.6.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.6.0/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.6.0/Dockerfile new file mode 100644 index 000000000..6d78fd220 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.6.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.6.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.6.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.6.0/Dockerfile.jdk7 new file mode 100644 index 000000000..5a91af7d6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.6.0/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.6.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.6.0/Makefile b/linux/ecosystem/atlassian/crowd/3/3.6.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.6.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.6.0/README.md b/linux/ecosystem/atlassian/crowd/3/3.6.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.6.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.6.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.6.0/docker-compose.yml new file mode 100644 index 000000000..4439f9170 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.6.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.6.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.6.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.6.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.6.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.6.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.6.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.6.2/.env b/linux/ecosystem/atlassian/crowd/3/3.6.2/.env new file mode 100644 index 000000000..469e6bbde --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.6.2/.env @@ -0,0 +1,3 @@ +RELEASE=3.6.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.6.2/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.6.2/Dockerfile new file mode 100644 index 000000000..0d0644b1b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.6.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.6.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.6.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.6.2/Dockerfile.jdk7 new file mode 100644 index 000000000..8b48e6a5b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.6.2/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.6.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.6.2/Makefile b/linux/ecosystem/atlassian/crowd/3/3.6.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.6.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.6.2/README.md b/linux/ecosystem/atlassian/crowd/3/3.6.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.6.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.6.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.6.2/docker-compose.yml new file mode 100644 index 000000000..1f6b05a2b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.6.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.6.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.6.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.6.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.6.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.6.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.6.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.0/.env b/linux/ecosystem/atlassian/crowd/3/3.7.0/.env new file mode 100644 index 000000000..6883f6208 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.0/.env @@ -0,0 +1,3 @@ +RELEASE=3.7.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.0/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.7.0/Dockerfile new file mode 100644 index 000000000..adcc34856 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.7.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.0/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.7.0/Dockerfile.jdk7 new file mode 100644 index 000000000..f5fb8ebd6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.0/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.7.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.0/Makefile b/linux/ecosystem/atlassian/crowd/3/3.7.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.0/README.md b/linux/ecosystem/atlassian/crowd/3/3.7.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.7.0/docker-compose.yml new file mode 100644 index 000000000..1d885c419 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.7.0" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.7.0-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.7.0-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.7.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.1/.env b/linux/ecosystem/atlassian/crowd/3/3.7.1/.env new file mode 100644 index 000000000..1282efab6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.1/.env @@ -0,0 +1,3 @@ +RELEASE=3.7.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.1/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.7.1/Dockerfile new file mode 100644 index 000000000..4e32fe714 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.1/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.7.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.1/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.7.1/Dockerfile.jdk7 new file mode 100644 index 000000000..17625e1ee --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.1/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.7.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.1/Makefile b/linux/ecosystem/atlassian/crowd/3/3.7.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.1/README.md b/linux/ecosystem/atlassian/crowd/3/3.7.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.7.1/docker-compose.yml new file mode 100644 index 000000000..28ea6b624 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.7.1" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.7.1-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.7.1-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.7.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.2/.env b/linux/ecosystem/atlassian/crowd/3/3.7.2/.env new file mode 100644 index 000000000..2a86f118f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.2/.env @@ -0,0 +1,3 @@ +RELEASE=3.7.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.2/Dockerfile b/linux/ecosystem/atlassian/crowd/3/3.7.2/Dockerfile new file mode 100644 index 000000000..f6874048f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk6 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.7.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.2/Dockerfile.jdk7 b/linux/ecosystem/atlassian/crowd/3/3.7.2/Dockerfile.jdk7 new file mode 100644 index 000000000..fed75010a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.2/Dockerfile.jdk7 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk7 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=3.7.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.2/Makefile b/linux/ecosystem/atlassian/crowd/3/3.7.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.2/README.md b/linux/ecosystem/atlassian/crowd/3/3.7.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/3/3.7.2/docker-compose.yml new file mode 100644 index 000000000..e1612e271 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:3.7.2" + build: + context: . + app-jdk6: + image: "epicmorg/crowd:3.7.2-jdk6" + build: + context: . + app-jdk7: + image: "epicmorg/crowd:3.7.2-jdk7" + build: + context: . + dockerfile: Dockerfile.jdk7 diff --git a/linux/ecosystem/atlassian/crowd/3/3.7.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/3/3.7.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/3/3.7.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.0/.env b/linux/ecosystem/atlassian/crowd/4/4.0.0/.env new file mode 100644 index 000000000..5ce5e71d6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.0/.env @@ -0,0 +1,3 @@ +RELEASE=4.0.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.0/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.0.0/Dockerfile new file mode 100644 index 000000000..d64f9c39e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.0.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.0/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.0.0/Dockerfile.jdk11 new file mode 100644 index 000000000..cced2590e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.0/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.0.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.0/Makefile b/linux/ecosystem/atlassian/crowd/4/4.0.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.0/README.md b/linux/ecosystem/atlassian/crowd/4/4.0.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.0.0/docker-compose.yml new file mode 100644 index 000000000..c6e88ac85 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.0.0" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.0.0-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.0.0-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.0.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.2/.env b/linux/ecosystem/atlassian/crowd/4/4.0.2/.env new file mode 100644 index 000000000..3c6520e21 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.2/.env @@ -0,0 +1,3 @@ +RELEASE=4.0.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.2/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.0.2/Dockerfile new file mode 100644 index 000000000..522ea032c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.0.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.2/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.0.2/Dockerfile.jdk11 new file mode 100644 index 000000000..528bdfe2d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.2/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.0.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.2/Makefile b/linux/ecosystem/atlassian/crowd/4/4.0.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.2/README.md b/linux/ecosystem/atlassian/crowd/4/4.0.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.0.2/docker-compose.yml new file mode 100644 index 000000000..48ab9da24 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.0.2" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.0.2-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.0.2-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.0.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.3/.env b/linux/ecosystem/atlassian/crowd/4/4.0.3/.env new file mode 100644 index 000000000..7abed80a6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.3/.env @@ -0,0 +1,3 @@ +RELEASE=4.0.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.3/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.0.3/Dockerfile new file mode 100644 index 000000000..bd20a403e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.0.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.3/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.0.3/Dockerfile.jdk11 new file mode 100644 index 000000000..ce52cebb3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.3/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.0.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.3/Makefile b/linux/ecosystem/atlassian/crowd/4/4.0.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.3/README.md b/linux/ecosystem/atlassian/crowd/4/4.0.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.0.3/docker-compose.yml new file mode 100644 index 000000000..c30fe8ccf --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.0.3" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.0.3-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.0.3-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.0.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.4/.env b/linux/ecosystem/atlassian/crowd/4/4.0.4/.env new file mode 100644 index 000000000..ae8386bba --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.4/.env @@ -0,0 +1,3 @@ +RELEASE=4.0.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.4/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.0.4/Dockerfile new file mode 100644 index 000000000..36d7f6ae0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.4/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.0.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.4/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.0.4/Dockerfile.jdk11 new file mode 100644 index 000000000..1ba434b5f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.4/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.0.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.4/Makefile b/linux/ecosystem/atlassian/crowd/4/4.0.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.4/README.md b/linux/ecosystem/atlassian/crowd/4/4.0.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.0.4/docker-compose.yml new file mode 100644 index 000000000..72be41257 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.0.4" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.0.4-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.0.4-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.0.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.5/.env b/linux/ecosystem/atlassian/crowd/4/4.0.5/.env new file mode 100644 index 000000000..685e0aceb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.5/.env @@ -0,0 +1,3 @@ +RELEASE=4.0.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.5/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.0.5/Dockerfile new file mode 100644 index 000000000..56924fa11 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.5/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.0.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.5/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.0.5/Dockerfile.jdk11 new file mode 100644 index 000000000..e61eed113 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.5/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.0.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.5/Makefile b/linux/ecosystem/atlassian/crowd/4/4.0.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.5/README.md b/linux/ecosystem/atlassian/crowd/4/4.0.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.0.5/docker-compose.yml new file mode 100644 index 000000000..cdbdad3a5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.0.5" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.0.5-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.0.5-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.0.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.0.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.0.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.0/.env b/linux/ecosystem/atlassian/crowd/4/4.1.0/.env new file mode 100644 index 000000000..fcf16b539 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.0/.env @@ -0,0 +1,3 @@ +RELEASE=4.1.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.0/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.1.0/Dockerfile new file mode 100644 index 000000000..2a24d6639 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.0/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.1.0/Dockerfile.jdk11 new file mode 100644 index 000000000..ad968229c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.0/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.0/Makefile b/linux/ecosystem/atlassian/crowd/4/4.1.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.0/README.md b/linux/ecosystem/atlassian/crowd/4/4.1.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.1.0/docker-compose.yml new file mode 100644 index 000000000..5456290c9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.1.0" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.1.0-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.1.0-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.1.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.1/.env b/linux/ecosystem/atlassian/crowd/4/4.1.1/.env new file mode 100644 index 000000000..142624cd5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.1/.env @@ -0,0 +1,3 @@ +RELEASE=4.1.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.1/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.1.1/Dockerfile new file mode 100644 index 000000000..29f6f934a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.1/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.1/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.1.1/Dockerfile.jdk11 new file mode 100644 index 000000000..3aaae4f41 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.1/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.1/Makefile b/linux/ecosystem/atlassian/crowd/4/4.1.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.1/README.md b/linux/ecosystem/atlassian/crowd/4/4.1.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.1.1/docker-compose.yml new file mode 100644 index 000000000..3f40f78c7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.1.1" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.1.1-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.1.1-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.1.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.10/.env b/linux/ecosystem/atlassian/crowd/4/4.1.10/.env new file mode 100644 index 000000000..f1f414afb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.10/.env @@ -0,0 +1,3 @@ +RELEASE=4.1.10 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.10/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.1.10/Dockerfile new file mode 100644 index 000000000..f018b9770 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.10/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.10 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.10/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.1.10/Dockerfile.jdk11 new file mode 100644 index 000000000..d8e1380e0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.10/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.10 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.10/Makefile b/linux/ecosystem/atlassian/crowd/4/4.1.10/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.10/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.10/README.md b/linux/ecosystem/atlassian/crowd/4/4.1.10/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.10/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.10/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.1.10/docker-compose.yml new file mode 100644 index 000000000..01d1c4f33 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.10/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.1.10" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.1.10-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.1.10-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.10/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.1.10/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.10/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.2/.env b/linux/ecosystem/atlassian/crowd/4/4.1.2/.env new file mode 100644 index 000000000..9401328fe --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.2/.env @@ -0,0 +1,3 @@ +RELEASE=4.1.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.2/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.1.2/Dockerfile new file mode 100644 index 000000000..29887b5fe --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.2/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.1.2/Dockerfile.jdk11 new file mode 100644 index 000000000..6fc6e5237 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.2/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.2/Makefile b/linux/ecosystem/atlassian/crowd/4/4.1.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.2/README.md b/linux/ecosystem/atlassian/crowd/4/4.1.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.1.2/docker-compose.yml new file mode 100644 index 000000000..74622a508 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.1.2" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.1.2-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.1.2-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.1.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.3/.env b/linux/ecosystem/atlassian/crowd/4/4.1.3/.env new file mode 100644 index 000000000..c76d82f06 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.3/.env @@ -0,0 +1,3 @@ +RELEASE=4.1.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.3/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.1.3/Dockerfile new file mode 100644 index 000000000..0a9d6190b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.3/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.1.3/Dockerfile.jdk11 new file mode 100644 index 000000000..480ee0eaf --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.3/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.3/Makefile b/linux/ecosystem/atlassian/crowd/4/4.1.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.3/README.md b/linux/ecosystem/atlassian/crowd/4/4.1.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.1.3/docker-compose.yml new file mode 100644 index 000000000..633386dcd --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.1.3" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.1.3-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.1.3-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.1.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.5/.env b/linux/ecosystem/atlassian/crowd/4/4.1.5/.env new file mode 100644 index 000000000..aa01cdd0e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.5/.env @@ -0,0 +1,3 @@ +RELEASE=4.1.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.5/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.1.5/Dockerfile new file mode 100644 index 000000000..2767ba261 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.5/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.5/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.1.5/Dockerfile.jdk11 new file mode 100644 index 000000000..e74bb8138 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.5/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.5/Makefile b/linux/ecosystem/atlassian/crowd/4/4.1.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.5/README.md b/linux/ecosystem/atlassian/crowd/4/4.1.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.1.5/docker-compose.yml new file mode 100644 index 000000000..62cb40135 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.1.5" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.1.5-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.1.5-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.1.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.6/.env b/linux/ecosystem/atlassian/crowd/4/4.1.6/.env new file mode 100644 index 000000000..eecc4d34e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.6/.env @@ -0,0 +1,3 @@ +RELEASE=4.1.6 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.6/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.1.6/Dockerfile new file mode 100644 index 000000000..eb2a11220 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.6/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.6/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.1.6/Dockerfile.jdk11 new file mode 100644 index 000000000..6d6e262f1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.6/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.6/Makefile b/linux/ecosystem/atlassian/crowd/4/4.1.6/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.6/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.6/README.md b/linux/ecosystem/atlassian/crowd/4/4.1.6/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.6/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.6/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.1.6/docker-compose.yml new file mode 100644 index 000000000..cdda6a5b6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.6/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.1.6" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.1.6-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.1.6-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.6/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.1.6/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.6/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.8/.env b/linux/ecosystem/atlassian/crowd/4/4.1.8/.env new file mode 100644 index 000000000..778703062 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.8/.env @@ -0,0 +1,3 @@ +RELEASE=4.1.8 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.8/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.1.8/Dockerfile new file mode 100644 index 000000000..9e293c630 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.8/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.8/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.1.8/Dockerfile.jdk11 new file mode 100644 index 000000000..54b5aa7e2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.8/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.8/Makefile b/linux/ecosystem/atlassian/crowd/4/4.1.8/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.8/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.8/README.md b/linux/ecosystem/atlassian/crowd/4/4.1.8/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.8/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.8/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.1.8/docker-compose.yml new file mode 100644 index 000000000..500d1c4f0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.8/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.1.8" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.1.8-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.1.8-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.8/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.1.8/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.8/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.9/.env b/linux/ecosystem/atlassian/crowd/4/4.1.9/.env new file mode 100644 index 000000000..c6bafdff3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.9/.env @@ -0,0 +1,3 @@ +RELEASE=4.1.9 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.9/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.1.9/Dockerfile new file mode 100644 index 000000000..35d3a35b2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.9/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.9/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.1.9/Dockerfile.jdk11 new file mode 100644 index 000000000..8d8b7c748 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.9/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.1.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.9/Makefile b/linux/ecosystem/atlassian/crowd/4/4.1.9/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.9/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.9/README.md b/linux/ecosystem/atlassian/crowd/4/4.1.9/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.9/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.9/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.1.9/docker-compose.yml new file mode 100644 index 000000000..60f54cb11 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.9/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.1.9" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.1.9-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.1.9-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.1.9/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.1.9/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.1.9/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.0/.env b/linux/ecosystem/atlassian/crowd/4/4.2.0/.env new file mode 100644 index 000000000..f0653caec --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.0/.env @@ -0,0 +1,3 @@ +RELEASE=4.2.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.0/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.2.0/Dockerfile new file mode 100644 index 000000000..3b5472098 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.2.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.0/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.2.0/Dockerfile.jdk11 new file mode 100644 index 000000000..57bd5b8c5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.0/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.2.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.0/Makefile b/linux/ecosystem/atlassian/crowd/4/4.2.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.0/README.md b/linux/ecosystem/atlassian/crowd/4/4.2.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.2.0/docker-compose.yml new file mode 100644 index 000000000..154b880e9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.2.0" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.2.0-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.2.0-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.2.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.1/.env b/linux/ecosystem/atlassian/crowd/4/4.2.1/.env new file mode 100644 index 000000000..d31847444 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.1/.env @@ -0,0 +1,3 @@ +RELEASE=4.2.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.1/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.2.1/Dockerfile new file mode 100644 index 000000000..fd1153b93 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.1/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.2.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.1/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.2.1/Dockerfile.jdk11 new file mode 100644 index 000000000..23119989b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.1/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.2.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.1/Makefile b/linux/ecosystem/atlassian/crowd/4/4.2.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.1/README.md b/linux/ecosystem/atlassian/crowd/4/4.2.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.2.1/docker-compose.yml new file mode 100644 index 000000000..22bc36d56 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.2.1" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.2.1-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.2.1-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.2.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.2/.env b/linux/ecosystem/atlassian/crowd/4/4.2.2/.env new file mode 100644 index 000000000..bf229b562 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.2/.env @@ -0,0 +1,3 @@ +RELEASE=4.2.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.2/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.2.2/Dockerfile new file mode 100644 index 000000000..14c091f4f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.2.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.2/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.2.2/Dockerfile.jdk11 new file mode 100644 index 000000000..be57a1624 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.2/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.2.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.2/Makefile b/linux/ecosystem/atlassian/crowd/4/4.2.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.2/README.md b/linux/ecosystem/atlassian/crowd/4/4.2.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.2.2/docker-compose.yml new file mode 100644 index 000000000..91e8fc884 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.2.2" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.2.2-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.2.2-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.2.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.3/.env b/linux/ecosystem/atlassian/crowd/4/4.2.3/.env new file mode 100644 index 000000000..6b4b69197 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.3/.env @@ -0,0 +1,3 @@ +RELEASE=4.2.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.3/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.2.3/Dockerfile new file mode 100644 index 000000000..d1198b0d3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.2.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.3/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.2.3/Dockerfile.jdk11 new file mode 100644 index 000000000..2108781cb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.3/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.2.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.3/Makefile b/linux/ecosystem/atlassian/crowd/4/4.2.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.3/README.md b/linux/ecosystem/atlassian/crowd/4/4.2.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.2.3/docker-compose.yml new file mode 100644 index 000000000..6ef71b62b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.2.3" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.2.3-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.2.3-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.2.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.4/.env b/linux/ecosystem/atlassian/crowd/4/4.2.4/.env new file mode 100644 index 000000000..16d936170 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.4/.env @@ -0,0 +1,3 @@ +RELEASE=4.2.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.4/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.2.4/Dockerfile new file mode 100644 index 000000000..de29bf627 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.4/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.2.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.4/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.2.4/Dockerfile.jdk11 new file mode 100644 index 000000000..e3c24faac --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.4/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.2.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.4/Makefile b/linux/ecosystem/atlassian/crowd/4/4.2.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.4/README.md b/linux/ecosystem/atlassian/crowd/4/4.2.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.2.4/docker-compose.yml new file mode 100644 index 000000000..ba8bc95b0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.2.4" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.2.4-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.2.4-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.2.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.5/.env b/linux/ecosystem/atlassian/crowd/4/4.2.5/.env new file mode 100644 index 000000000..df6db71fd --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.5/.env @@ -0,0 +1,3 @@ +RELEASE=4.2.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.5/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.2.5/Dockerfile new file mode 100644 index 000000000..7fca496af --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.5/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.2.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.5/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.2.5/Dockerfile.jdk11 new file mode 100644 index 000000000..6076d02d0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.5/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.2.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.5/Makefile b/linux/ecosystem/atlassian/crowd/4/4.2.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.5/README.md b/linux/ecosystem/atlassian/crowd/4/4.2.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.2.5/docker-compose.yml new file mode 100644 index 000000000..a3e58c289 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.2.5" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.2.5-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.2.5-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.2.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.2.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.2.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.0/.env b/linux/ecosystem/atlassian/crowd/4/4.3.0/.env new file mode 100644 index 000000000..cb4a30d55 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.0/.env @@ -0,0 +1,3 @@ +RELEASE=4.3.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.0/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.3.0/Dockerfile new file mode 100644 index 000000000..833833e2f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.3.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.0/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.3.0/Dockerfile.jdk11 new file mode 100644 index 000000000..a3d3633cc --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.0/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.3.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.0/Makefile b/linux/ecosystem/atlassian/crowd/4/4.3.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.0/README.md b/linux/ecosystem/atlassian/crowd/4/4.3.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.3.0/docker-compose.yml new file mode 100644 index 000000000..46df9d472 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.3.0" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.3.0-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.3.0-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.3.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.10/.env b/linux/ecosystem/atlassian/crowd/4/4.3.10/.env new file mode 100644 index 000000000..57aab5e77 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.10/.env @@ -0,0 +1,3 @@ +RELEASE=4.3.10 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.10/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.3.10/Dockerfile new file mode 100644 index 000000000..f0070e8b8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.10/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.3.10 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.10/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.3.10/Dockerfile.jdk11 new file mode 100644 index 000000000..5d6a504f9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.10/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.3.10 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.10/Makefile b/linux/ecosystem/atlassian/crowd/4/4.3.10/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.10/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.10/README.md b/linux/ecosystem/atlassian/crowd/4/4.3.10/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.10/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.10/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.3.10/docker-compose.yml new file mode 100644 index 000000000..8c9ffe666 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.10/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.3.10" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.3.10-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.3.10-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.10/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.3.10/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.10/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.11/.env b/linux/ecosystem/atlassian/crowd/4/4.3.11/.env new file mode 100644 index 000000000..55339b8ed --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.11/.env @@ -0,0 +1,3 @@ +RELEASE=4.3.11 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.11/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.3.11/Dockerfile new file mode 100644 index 000000000..b7998d496 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.11/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.3.11 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.11/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.3.11/Dockerfile.jdk11 new file mode 100644 index 000000000..7d47d08a1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.11/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.3.11 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.11/Makefile b/linux/ecosystem/atlassian/crowd/4/4.3.11/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.11/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.11/README.md b/linux/ecosystem/atlassian/crowd/4/4.3.11/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.11/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.11/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.3.11/docker-compose.yml new file mode 100644 index 000000000..4c117eb2e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.11/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.3.11" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.3.11-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.3.11-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.11/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.3.11/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.11/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.5/.env b/linux/ecosystem/atlassian/crowd/4/4.3.5/.env new file mode 100644 index 000000000..521d768f5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.5/.env @@ -0,0 +1,3 @@ +RELEASE=4.3.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.5/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.3.5/Dockerfile new file mode 100644 index 000000000..922e51a58 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.5/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.3.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.5/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.3.5/Dockerfile.jdk11 new file mode 100644 index 000000000..0cdeb0db1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.5/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.3.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.5/Makefile b/linux/ecosystem/atlassian/crowd/4/4.3.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.5/README.md b/linux/ecosystem/atlassian/crowd/4/4.3.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.3.5/docker-compose.yml new file mode 100644 index 000000000..0b257108d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.3.5" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.3.5-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.3.5-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.3.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.7/.env b/linux/ecosystem/atlassian/crowd/4/4.3.7/.env new file mode 100644 index 000000000..de5a3085d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.7/.env @@ -0,0 +1,3 @@ +RELEASE=4.3.7 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.7/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.3.7/Dockerfile new file mode 100644 index 000000000..1d7efc086 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.7/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.3.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.7/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.3.7/Dockerfile.jdk11 new file mode 100644 index 000000000..2e62d10ba --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.7/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.3.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.7/Makefile b/linux/ecosystem/atlassian/crowd/4/4.3.7/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.7/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.7/README.md b/linux/ecosystem/atlassian/crowd/4/4.3.7/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.7/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.7/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.3.7/docker-compose.yml new file mode 100644 index 000000000..35e2cce3b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.7/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.3.7" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.3.7-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.3.7-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.7/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.3.7/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.7/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.8/.env b/linux/ecosystem/atlassian/crowd/4/4.3.8/.env new file mode 100644 index 000000000..681cb13cc --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.8/.env @@ -0,0 +1,3 @@ +RELEASE=4.3.8 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.8/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.3.8/Dockerfile new file mode 100644 index 000000000..80fca2c35 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.8/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.3.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.8/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.3.8/Dockerfile.jdk11 new file mode 100644 index 000000000..301632e55 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.8/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.3.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.8/Makefile b/linux/ecosystem/atlassian/crowd/4/4.3.8/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.8/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.8/README.md b/linux/ecosystem/atlassian/crowd/4/4.3.8/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.8/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.8/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.3.8/docker-compose.yml new file mode 100644 index 000000000..267d9f14d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.8/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.3.8" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.3.8-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.3.8-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.8/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.3.8/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.8/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.9/.env b/linux/ecosystem/atlassian/crowd/4/4.3.9/.env new file mode 100644 index 000000000..e68fa48e5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.9/.env @@ -0,0 +1,3 @@ +RELEASE=4.3.9 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.9/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.3.9/Dockerfile new file mode 100644 index 000000000..40ccda0f0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.9/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.3.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.9/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.3.9/Dockerfile.jdk11 new file mode 100644 index 000000000..a17382049 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.9/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.3.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.9/Makefile b/linux/ecosystem/atlassian/crowd/4/4.3.9/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.9/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.9/README.md b/linux/ecosystem/atlassian/crowd/4/4.3.9/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.9/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.9/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.3.9/docker-compose.yml new file mode 100644 index 000000000..bd816adaa --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.9/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.3.9" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.3.9-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.3.9-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.3.9/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.3.9/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.3.9/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.0/.env b/linux/ecosystem/atlassian/crowd/4/4.4.0/.env new file mode 100644 index 000000000..f258d481b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.0/.env @@ -0,0 +1,3 @@ +RELEASE=4.4.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.0/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.4.0/Dockerfile new file mode 100644 index 000000000..15909fb27 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.4.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.0/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.4.0/Dockerfile.jdk11 new file mode 100644 index 000000000..a6f42130d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.0/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.4.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.0/Makefile b/linux/ecosystem/atlassian/crowd/4/4.4.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.0/README.md b/linux/ecosystem/atlassian/crowd/4/4.4.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.4.0/docker-compose.yml new file mode 100644 index 000000000..28115ea01 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.4.0" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.4.0-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.4.0-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.4.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.1/.env b/linux/ecosystem/atlassian/crowd/4/4.4.1/.env new file mode 100644 index 000000000..e11bf1618 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.1/.env @@ -0,0 +1,3 @@ +RELEASE=4.4.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.1/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.4.1/Dockerfile new file mode 100644 index 000000000..919ae7419 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.1/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.4.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.1/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.4.1/Dockerfile.jdk11 new file mode 100644 index 000000000..e73ad9502 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.1/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.4.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.1/Makefile b/linux/ecosystem/atlassian/crowd/4/4.4.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.1/README.md b/linux/ecosystem/atlassian/crowd/4/4.4.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.4.1/docker-compose.yml new file mode 100644 index 000000000..329863644 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.4.1" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.4.1-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.4.1-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.4.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.2/.env b/linux/ecosystem/atlassian/crowd/4/4.4.2/.env new file mode 100644 index 000000000..e05f50c87 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.2/.env @@ -0,0 +1,3 @@ +RELEASE=4.4.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.2/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.4.2/Dockerfile new file mode 100644 index 000000000..3df67b8f1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.4.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.2/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.4.2/Dockerfile.jdk11 new file mode 100644 index 000000000..eb4a6c051 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.2/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.4.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.2/Makefile b/linux/ecosystem/atlassian/crowd/4/4.4.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.2/README.md b/linux/ecosystem/atlassian/crowd/4/4.4.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.4.2/docker-compose.yml new file mode 100644 index 000000000..10f114559 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.4.2" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.4.2-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.4.2-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.4.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.3/.env b/linux/ecosystem/atlassian/crowd/4/4.4.3/.env new file mode 100644 index 000000000..1ea6b583a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.3/.env @@ -0,0 +1,3 @@ +RELEASE=4.4.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.3/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.4.3/Dockerfile new file mode 100644 index 000000000..4b74bdd66 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.4.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.3/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.4.3/Dockerfile.jdk11 new file mode 100644 index 000000000..57f4e53e5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.3/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.4.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.3/Makefile b/linux/ecosystem/atlassian/crowd/4/4.4.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.3/README.md b/linux/ecosystem/atlassian/crowd/4/4.4.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.4.3/docker-compose.yml new file mode 100644 index 000000000..d125fedff --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.4.3" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.4.3-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.4.3-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.4.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.4/.env b/linux/ecosystem/atlassian/crowd/4/4.4.4/.env new file mode 100644 index 000000000..085ce1a58 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.4/.env @@ -0,0 +1,3 @@ +RELEASE=4.4.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.4/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.4.4/Dockerfile new file mode 100644 index 000000000..5c2c61b1c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.4/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.4.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.4/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.4.4/Dockerfile.jdk11 new file mode 100644 index 000000000..135563940 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.4/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.4.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.4/Makefile b/linux/ecosystem/atlassian/crowd/4/4.4.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.4/README.md b/linux/ecosystem/atlassian/crowd/4/4.4.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.4.4/docker-compose.yml new file mode 100644 index 000000000..ad9ac244d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.4.4" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.4.4-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.4.4-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.4.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.5/.env b/linux/ecosystem/atlassian/crowd/4/4.4.5/.env new file mode 100644 index 000000000..3e57002f6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.5/.env @@ -0,0 +1,3 @@ +RELEASE=4.4.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.5/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.4.5/Dockerfile new file mode 100644 index 000000000..b313c4b1a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.5/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.4.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.5/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.4.5/Dockerfile.jdk11 new file mode 100644 index 000000000..96218275c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.5/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.4.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.5/Makefile b/linux/ecosystem/atlassian/crowd/4/4.4.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.5/README.md b/linux/ecosystem/atlassian/crowd/4/4.4.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.4.5/docker-compose.yml new file mode 100644 index 000000000..f6dc2a95b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.4.5" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.4.5-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.4.5-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.4.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.6/.env b/linux/ecosystem/atlassian/crowd/4/4.4.6/.env new file mode 100644 index 000000000..557e4dda9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.6/.env @@ -0,0 +1,3 @@ +RELEASE=4.4.6 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.6/Dockerfile b/linux/ecosystem/atlassian/crowd/4/4.4.6/Dockerfile new file mode 100644 index 000000000..4b866c6c4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.6/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.4.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.6/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/4/4.4.6/Dockerfile.jdk11 new file mode 100644 index 000000000..6bc186630 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.6/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=4.4.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.6/Makefile b/linux/ecosystem/atlassian/crowd/4/4.4.6/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.6/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.6/README.md b/linux/ecosystem/atlassian/crowd/4/4.4.6/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.6/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.6/docker-compose.yml b/linux/ecosystem/atlassian/crowd/4/4.4.6/docker-compose.yml new file mode 100644 index 000000000..ea476aa31 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.6/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:4.4.6" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:4.4.6-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:4.4.6-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/4/4.4.6/entrypoint.sh b/linux/ecosystem/atlassian/crowd/4/4.4.6/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/4/4.4.6/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.0/.env b/linux/ecosystem/atlassian/crowd/5/5.0.0/.env new file mode 100644 index 000000000..666d9682f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.0/.env @@ -0,0 +1,3 @@ +RELEASE=5.0.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.0/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.0.0/Dockerfile new file mode 100644 index 000000000..5dae4401d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.0/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.0.0/Dockerfile.jdk11 new file mode 100644 index 000000000..4d296cfdc --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.0/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.0/Makefile b/linux/ecosystem/atlassian/crowd/5/5.0.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.0/README.md b/linux/ecosystem/atlassian/crowd/5/5.0.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.0.0/docker-compose.yml new file mode 100644 index 000000000..00ef4d8e3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.0.0" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.0.0-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.0.0-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.0.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.1/.env b/linux/ecosystem/atlassian/crowd/5/5.0.1/.env new file mode 100644 index 000000000..4aa9bcdf2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.1/.env @@ -0,0 +1,3 @@ +RELEASE=5.0.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.1/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.0.1/Dockerfile new file mode 100644 index 000000000..10d7c7148 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.1/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.1/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.0.1/Dockerfile.jdk11 new file mode 100644 index 000000000..cf7bcf555 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.1/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.1/Makefile b/linux/ecosystem/atlassian/crowd/5/5.0.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.1/README.md b/linux/ecosystem/atlassian/crowd/5/5.0.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.0.1/docker-compose.yml new file mode 100644 index 000000000..c0f3b1c15 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.0.1" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.0.1-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.0.1-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.0.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.10/.env b/linux/ecosystem/atlassian/crowd/5/5.0.10/.env new file mode 100644 index 000000000..4d22c7998 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.10/.env @@ -0,0 +1,3 @@ +RELEASE=5.0.10 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.10/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.0.10/Dockerfile new file mode 100644 index 000000000..081ff579b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.10/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.10 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.10/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.0.10/Dockerfile.jdk11 new file mode 100644 index 000000000..3c5cd2725 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.10/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.10 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.10/Makefile b/linux/ecosystem/atlassian/crowd/5/5.0.10/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.10/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.10/README.md b/linux/ecosystem/atlassian/crowd/5/5.0.10/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.10/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.10/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.0.10/docker-compose.yml new file mode 100644 index 000000000..b00cb33c4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.10/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.0.10" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.0.10-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.0.10-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.10/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.0.10/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.10/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.11/.env b/linux/ecosystem/atlassian/crowd/5/5.0.11/.env new file mode 100644 index 000000000..d1852aa8d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.11/.env @@ -0,0 +1,3 @@ +RELEASE=5.0.11 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.11/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.0.11/Dockerfile new file mode 100644 index 000000000..122ce8a9c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.11/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.11 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.11/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.0.11/Dockerfile.jdk11 new file mode 100644 index 000000000..a06c77491 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.11/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.11 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.11/Makefile b/linux/ecosystem/atlassian/crowd/5/5.0.11/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.11/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.11/README.md b/linux/ecosystem/atlassian/crowd/5/5.0.11/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.11/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.11/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.0.11/docker-compose.yml new file mode 100644 index 000000000..750a192cc --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.11/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.0.11" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.0.11-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.0.11-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.11/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.0.11/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.11/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.2/.env b/linux/ecosystem/atlassian/crowd/5/5.0.2/.env new file mode 100644 index 000000000..1238cff19 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.2/.env @@ -0,0 +1,3 @@ +RELEASE=5.0.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.2/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.0.2/Dockerfile new file mode 100644 index 000000000..44a8b9d96 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.2/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.0.2/Dockerfile.jdk11 new file mode 100644 index 000000000..124bc3684 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.2/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.2/Makefile b/linux/ecosystem/atlassian/crowd/5/5.0.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.2/README.md b/linux/ecosystem/atlassian/crowd/5/5.0.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.0.2/docker-compose.yml new file mode 100644 index 000000000..41082c5bd --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.0.2" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.0.2-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.0.2-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.0.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.3/.env b/linux/ecosystem/atlassian/crowd/5/5.0.3/.env new file mode 100644 index 000000000..b119e1d66 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.3/.env @@ -0,0 +1,3 @@ +RELEASE=5.0.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.3/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.0.3/Dockerfile new file mode 100644 index 000000000..31f925d57 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.3/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.0.3/Dockerfile.jdk11 new file mode 100644 index 000000000..bbcdea2c3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.3/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.3/Makefile b/linux/ecosystem/atlassian/crowd/5/5.0.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.3/README.md b/linux/ecosystem/atlassian/crowd/5/5.0.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.0.3/docker-compose.yml new file mode 100644 index 000000000..ee563a21b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.0.3" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.0.3-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.0.3-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.0.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.4/.env b/linux/ecosystem/atlassian/crowd/5/5.0.4/.env new file mode 100644 index 000000000..dd8c1cf72 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.4/.env @@ -0,0 +1,3 @@ +RELEASE=5.0.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.4/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.0.4/Dockerfile new file mode 100644 index 000000000..359e72b6b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.4/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.4/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.0.4/Dockerfile.jdk11 new file mode 100644 index 000000000..8781b7536 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.4/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.4/Makefile b/linux/ecosystem/atlassian/crowd/5/5.0.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.4/README.md b/linux/ecosystem/atlassian/crowd/5/5.0.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.0.4/docker-compose.yml new file mode 100644 index 000000000..8c5d69c03 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.0.4" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.0.4-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.0.4-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.0.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.5/.env b/linux/ecosystem/atlassian/crowd/5/5.0.5/.env new file mode 100644 index 000000000..2339225d1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.5/.env @@ -0,0 +1,3 @@ +RELEASE=5.0.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.5/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.0.5/Dockerfile new file mode 100644 index 000000000..d540abfcc --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.5/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.5/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.0.5/Dockerfile.jdk11 new file mode 100644 index 000000000..0998c5241 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.5/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.5/Makefile b/linux/ecosystem/atlassian/crowd/5/5.0.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.5/README.md b/linux/ecosystem/atlassian/crowd/5/5.0.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.0.5/docker-compose.yml new file mode 100644 index 000000000..77be49df3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.0.5" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.0.5-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.0.5-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.0.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.6/.env b/linux/ecosystem/atlassian/crowd/5/5.0.6/.env new file mode 100644 index 000000000..c383eb33a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.6/.env @@ -0,0 +1,3 @@ +RELEASE=5.0.6 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.6/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.0.6/Dockerfile new file mode 100644 index 000000000..69785e21c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.6/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.6/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.0.6/Dockerfile.jdk11 new file mode 100644 index 000000000..a59134e64 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.6/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.6/Makefile b/linux/ecosystem/atlassian/crowd/5/5.0.6/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.6/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.6/README.md b/linux/ecosystem/atlassian/crowd/5/5.0.6/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.6/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.6/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.0.6/docker-compose.yml new file mode 100644 index 000000000..20721cb8f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.6/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.0.6" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.0.6-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.0.6-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.6/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.0.6/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.6/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.7/.env b/linux/ecosystem/atlassian/crowd/5/5.0.7/.env new file mode 100644 index 000000000..4bf05a25b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.7/.env @@ -0,0 +1,3 @@ +RELEASE=5.0.7 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.7/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.0.7/Dockerfile new file mode 100644 index 000000000..3e60d2186 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.7/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.7/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.0.7/Dockerfile.jdk11 new file mode 100644 index 000000000..fef96882f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.7/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.7/Makefile b/linux/ecosystem/atlassian/crowd/5/5.0.7/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.7/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.7/README.md b/linux/ecosystem/atlassian/crowd/5/5.0.7/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.7/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.7/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.0.7/docker-compose.yml new file mode 100644 index 000000000..df4bccf0d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.7/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.0.7" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.0.7-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.0.7-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.7/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.0.7/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.7/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.8/.env b/linux/ecosystem/atlassian/crowd/5/5.0.8/.env new file mode 100644 index 000000000..6087186df --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.8/.env @@ -0,0 +1,3 @@ +RELEASE=5.0.8 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.8/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.0.8/Dockerfile new file mode 100644 index 000000000..1078550b6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.8/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.8/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.0.8/Dockerfile.jdk11 new file mode 100644 index 000000000..d426ef501 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.8/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.8/Makefile b/linux/ecosystem/atlassian/crowd/5/5.0.8/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.8/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.8/README.md b/linux/ecosystem/atlassian/crowd/5/5.0.8/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.8/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.8/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.0.8/docker-compose.yml new file mode 100644 index 000000000..87074ede9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.8/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.0.8" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.0.8-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.0.8-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.8/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.0.8/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.8/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.9/.env b/linux/ecosystem/atlassian/crowd/5/5.0.9/.env new file mode 100644 index 000000000..f0164e8a2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.9/.env @@ -0,0 +1,3 @@ +RELEASE=5.0.9 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.9/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.0.9/Dockerfile new file mode 100644 index 000000000..081ab1500 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.9/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.9/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.0.9/Dockerfile.jdk11 new file mode 100644 index 000000000..f519ee3e6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.9/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.0.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.9/Makefile b/linux/ecosystem/atlassian/crowd/5/5.0.9/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.9/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.9/README.md b/linux/ecosystem/atlassian/crowd/5/5.0.9/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.9/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.9/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.0.9/docker-compose.yml new file mode 100644 index 000000000..2be31a8d4 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.9/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.0.9" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.0.9-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.0.9-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.0.9/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.0.9/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.0.9/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.0/.env b/linux/ecosystem/atlassian/crowd/5/5.1.0/.env new file mode 100644 index 000000000..f7cb09e0c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.0/.env @@ -0,0 +1,3 @@ +RELEASE=5.1.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.0/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.1.0/Dockerfile new file mode 100644 index 000000000..e9d678b9c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.0/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.1.0/Dockerfile.jdk11 new file mode 100644 index 000000000..27234a660 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.0/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.0/Makefile b/linux/ecosystem/atlassian/crowd/5/5.1.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.0/README.md b/linux/ecosystem/atlassian/crowd/5/5.1.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.1.0/docker-compose.yml new file mode 100644 index 000000000..d9c45e524 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.1.0" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.1.0-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.1.0-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.1.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.1/.env b/linux/ecosystem/atlassian/crowd/5/5.1.1/.env new file mode 100644 index 000000000..c4c68614c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.1/.env @@ -0,0 +1,3 @@ +RELEASE=5.1.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.1/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.1.1/Dockerfile new file mode 100644 index 000000000..748d21f9a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.1/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.1/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.1.1/Dockerfile.jdk11 new file mode 100644 index 000000000..40ad3e6d7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.1/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.1/Makefile b/linux/ecosystem/atlassian/crowd/5/5.1.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.1/README.md b/linux/ecosystem/atlassian/crowd/5/5.1.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.1.1/docker-compose.yml new file mode 100644 index 000000000..078f66a74 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.1.1" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.1.1-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.1.1-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.1.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.11/.env b/linux/ecosystem/atlassian/crowd/5/5.1.11/.env new file mode 100644 index 000000000..4ce43e5ec --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.11/.env @@ -0,0 +1,3 @@ +RELEASE=5.1.11 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.11/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.1.11/Dockerfile new file mode 100644 index 000000000..5b48eee24 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.11/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.11 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.11/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.1.11/Dockerfile.jdk11 new file mode 100644 index 000000000..17115a881 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.11/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.11 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.11/Makefile b/linux/ecosystem/atlassian/crowd/5/5.1.11/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.11/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.11/README.md b/linux/ecosystem/atlassian/crowd/5/5.1.11/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.11/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.11/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.1.11/docker-compose.yml new file mode 100644 index 000000000..065b2c779 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.11/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.1.11" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.1.11-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.1.11-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.11/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.1.11/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.11/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.12/.env b/linux/ecosystem/atlassian/crowd/5/5.1.12/.env new file mode 100644 index 000000000..52c4b0dd6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.12/.env @@ -0,0 +1,3 @@ +RELEASE=5.1.12 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.12/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.1.12/Dockerfile new file mode 100644 index 000000000..99d91afca --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.12/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.12 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.12/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.1.12/Dockerfile.jdk11 new file mode 100644 index 000000000..3d25530f0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.12/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.12 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.12/Makefile b/linux/ecosystem/atlassian/crowd/5/5.1.12/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.12/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.12/README.md b/linux/ecosystem/atlassian/crowd/5/5.1.12/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.12/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.12/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.1.12/docker-compose.yml new file mode 100644 index 000000000..f8fe70144 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.12/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.1.12" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.1.12-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.1.12-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.12/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.1.12/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.12/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.13/.env b/linux/ecosystem/atlassian/crowd/5/5.1.13/.env new file mode 100644 index 000000000..b5d7b9771 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.13/.env @@ -0,0 +1,3 @@ +RELEASE=5.1.13 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.13/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.1.13/Dockerfile new file mode 100644 index 000000000..d74fff8a2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.13/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.13 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.13/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.1.13/Dockerfile.jdk11 new file mode 100644 index 000000000..2e73d3f16 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.13/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.13 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.13/Makefile b/linux/ecosystem/atlassian/crowd/5/5.1.13/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.13/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.13/README.md b/linux/ecosystem/atlassian/crowd/5/5.1.13/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.13/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.13/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.1.13/docker-compose.yml new file mode 100644 index 000000000..1e880c132 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.13/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.1.13" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.1.13-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.1.13-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.13/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.1.13/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.13/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.2/.env b/linux/ecosystem/atlassian/crowd/5/5.1.2/.env new file mode 100644 index 000000000..935b99f1c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.2/.env @@ -0,0 +1,3 @@ +RELEASE=5.1.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.2/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.1.2/Dockerfile new file mode 100644 index 000000000..8b09a1a4d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.2/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.1.2/Dockerfile.jdk11 new file mode 100644 index 000000000..1dc1185fe --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.2/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.2/Makefile b/linux/ecosystem/atlassian/crowd/5/5.1.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.2/README.md b/linux/ecosystem/atlassian/crowd/5/5.1.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.1.2/docker-compose.yml new file mode 100644 index 000000000..39003126c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.1.2" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.1.2-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.1.2-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.1.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.3/.env b/linux/ecosystem/atlassian/crowd/5/5.1.3/.env new file mode 100644 index 000000000..b5d14848d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.3/.env @@ -0,0 +1,3 @@ +RELEASE=5.1.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.3/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.1.3/Dockerfile new file mode 100644 index 000000000..69cdce83d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.3/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.1.3/Dockerfile.jdk11 new file mode 100644 index 000000000..fa7ab38a7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.3/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.3/Makefile b/linux/ecosystem/atlassian/crowd/5/5.1.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.3/README.md b/linux/ecosystem/atlassian/crowd/5/5.1.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.1.3/docker-compose.yml new file mode 100644 index 000000000..40ea1b402 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.1.3" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.1.3-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.1.3-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.1.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.4/.env b/linux/ecosystem/atlassian/crowd/5/5.1.4/.env new file mode 100644 index 000000000..ce689d904 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.4/.env @@ -0,0 +1,3 @@ +RELEASE=5.1.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.4/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.1.4/Dockerfile new file mode 100644 index 000000000..7d6b05c6a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.4/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.4/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.1.4/Dockerfile.jdk11 new file mode 100644 index 000000000..6d98e663d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.4/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.4/Makefile b/linux/ecosystem/atlassian/crowd/5/5.1.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.4/README.md b/linux/ecosystem/atlassian/crowd/5/5.1.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.1.4/docker-compose.yml new file mode 100644 index 000000000..9904fffb7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.1.4" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.1.4-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.1.4-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.1.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.5/.env b/linux/ecosystem/atlassian/crowd/5/5.1.5/.env new file mode 100644 index 000000000..dc8befa95 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.5/.env @@ -0,0 +1,3 @@ +RELEASE=5.1.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.5/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.1.5/Dockerfile new file mode 100644 index 000000000..eae7cdd36 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.5/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.5/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.1.5/Dockerfile.jdk11 new file mode 100644 index 000000000..11dac0f1f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.5/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.5/Makefile b/linux/ecosystem/atlassian/crowd/5/5.1.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.5/README.md b/linux/ecosystem/atlassian/crowd/5/5.1.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.1.5/docker-compose.yml new file mode 100644 index 000000000..197505749 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.1.5" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.1.5-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.1.5-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.1.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.6/.env b/linux/ecosystem/atlassian/crowd/5/5.1.6/.env new file mode 100644 index 000000000..3014a456f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.6/.env @@ -0,0 +1,3 @@ +RELEASE=5.1.6 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.6/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.1.6/Dockerfile new file mode 100644 index 000000000..c6629ec9a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.6/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.6/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.1.6/Dockerfile.jdk11 new file mode 100644 index 000000000..08ae3c876 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.6/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.6/Makefile b/linux/ecosystem/atlassian/crowd/5/5.1.6/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.6/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.6/README.md b/linux/ecosystem/atlassian/crowd/5/5.1.6/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.6/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.6/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.1.6/docker-compose.yml new file mode 100644 index 000000000..ad0130850 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.6/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.1.6" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.1.6-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.1.6-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.6/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.1.6/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.6/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.7/.env b/linux/ecosystem/atlassian/crowd/5/5.1.7/.env new file mode 100644 index 000000000..06f5f48aa --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.7/.env @@ -0,0 +1,3 @@ +RELEASE=5.1.7 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.7/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.1.7/Dockerfile new file mode 100644 index 000000000..68e363447 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.7/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.7/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.1.7/Dockerfile.jdk11 new file mode 100644 index 000000000..20b79f841 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.7/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.7/Makefile b/linux/ecosystem/atlassian/crowd/5/5.1.7/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.7/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.7/README.md b/linux/ecosystem/atlassian/crowd/5/5.1.7/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.7/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.7/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.1.7/docker-compose.yml new file mode 100644 index 000000000..c2bb34180 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.7/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.1.7" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.1.7-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.1.7-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.7/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.1.7/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.7/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.8/.env b/linux/ecosystem/atlassian/crowd/5/5.1.8/.env new file mode 100644 index 000000000..6cab6b68c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.8/.env @@ -0,0 +1,3 @@ +RELEASE=5.1.8 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.8/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.1.8/Dockerfile new file mode 100644 index 000000000..12ecfd0f6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.8/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.8/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.1.8/Dockerfile.jdk11 new file mode 100644 index 000000000..df134b143 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.8/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.8/Makefile b/linux/ecosystem/atlassian/crowd/5/5.1.8/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.8/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.8/README.md b/linux/ecosystem/atlassian/crowd/5/5.1.8/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.8/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.8/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.1.8/docker-compose.yml new file mode 100644 index 000000000..34c338655 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.8/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.1.8" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.1.8-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.1.8-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.8/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.1.8/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.8/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.9/.env b/linux/ecosystem/atlassian/crowd/5/5.1.9/.env new file mode 100644 index 000000000..53a01ec22 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.9/.env @@ -0,0 +1,3 @@ +RELEASE=5.1.9 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.9/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.1.9/Dockerfile new file mode 100644 index 000000000..e62974df8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.9/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.9/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.1.9/Dockerfile.jdk11 new file mode 100644 index 000000000..29b19cde0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.9/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.1.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.9/Makefile b/linux/ecosystem/atlassian/crowd/5/5.1.9/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.9/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.9/README.md b/linux/ecosystem/atlassian/crowd/5/5.1.9/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.9/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.9/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.1.9/docker-compose.yml new file mode 100644 index 000000000..0202bbb7d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.9/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.1.9" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.1.9-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.1.9-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.1.9/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.1.9/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.1.9/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.0/.env b/linux/ecosystem/atlassian/crowd/5/5.2.0/.env new file mode 100644 index 000000000..dfcc4f01c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.0/.env @@ -0,0 +1,3 @@ +RELEASE=5.2.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.0/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.2.0/Dockerfile new file mode 100644 index 000000000..ef78034ab --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.0/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.2.0/Dockerfile.jdk11 new file mode 100644 index 000000000..8a14b13b3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.0/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.0/Makefile b/linux/ecosystem/atlassian/crowd/5/5.2.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.0/README.md b/linux/ecosystem/atlassian/crowd/5/5.2.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.2.0/docker-compose.yml new file mode 100644 index 000000000..3f1191d9f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.2.0" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.2.0-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.2.0-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.2.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.1/.env b/linux/ecosystem/atlassian/crowd/5/5.2.1/.env new file mode 100644 index 000000000..2b6d801ec --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.1/.env @@ -0,0 +1,3 @@ +RELEASE=5.2.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.1/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.2.1/Dockerfile new file mode 100644 index 000000000..bd585904c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.1/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.1/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.2.1/Dockerfile.jdk11 new file mode 100644 index 000000000..0bd68abeb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.1/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.1/Makefile b/linux/ecosystem/atlassian/crowd/5/5.2.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.1/README.md b/linux/ecosystem/atlassian/crowd/5/5.2.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.2.1/docker-compose.yml new file mode 100644 index 000000000..788665f80 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.2.1" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.2.1-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.2.1-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.2.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.10/.env b/linux/ecosystem/atlassian/crowd/5/5.2.10/.env new file mode 100644 index 000000000..8091e032e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.10/.env @@ -0,0 +1,3 @@ +RELEASE=5.2.10 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.10/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.2.10/Dockerfile new file mode 100644 index 000000000..f526cfc48 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.10/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.10 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.10/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.2.10/Dockerfile.jdk11 new file mode 100644 index 000000000..9223a9a7b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.10/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.10 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.10/Makefile b/linux/ecosystem/atlassian/crowd/5/5.2.10/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.10/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.10/README.md b/linux/ecosystem/atlassian/crowd/5/5.2.10/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.10/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.10/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.2.10/docker-compose.yml new file mode 100644 index 000000000..d8a0a8fd6 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.10/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.2.10" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.2.10-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.2.10-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.10/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.2.10/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.10/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.2/.env b/linux/ecosystem/atlassian/crowd/5/5.2.2/.env new file mode 100644 index 000000000..1262783b7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.2/.env @@ -0,0 +1,3 @@ +RELEASE=5.2.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.2/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.2.2/Dockerfile new file mode 100644 index 000000000..5156a3c9e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.2/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.2.2/Dockerfile.jdk11 new file mode 100644 index 000000000..15c7be089 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.2/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.2/Makefile b/linux/ecosystem/atlassian/crowd/5/5.2.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.2/README.md b/linux/ecosystem/atlassian/crowd/5/5.2.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.2.2/docker-compose.yml new file mode 100644 index 000000000..d91e1115c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.2.2" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.2.2-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.2.2-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.2.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.3/.env b/linux/ecosystem/atlassian/crowd/5/5.2.3/.env new file mode 100644 index 000000000..e512062d3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.3/.env @@ -0,0 +1,3 @@ +RELEASE=5.2.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.3/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.2.3/Dockerfile new file mode 100644 index 000000000..5537d9320 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.3/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.2.3/Dockerfile.jdk11 new file mode 100644 index 000000000..bbebac54b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.3/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.3/Makefile b/linux/ecosystem/atlassian/crowd/5/5.2.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.3/README.md b/linux/ecosystem/atlassian/crowd/5/5.2.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.2.3/docker-compose.yml new file mode 100644 index 000000000..0037006d2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.2.3" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.2.3-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.2.3-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.2.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.4/.env b/linux/ecosystem/atlassian/crowd/5/5.2.4/.env new file mode 100644 index 000000000..453368008 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.4/.env @@ -0,0 +1,3 @@ +RELEASE=5.2.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.4/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.2.4/Dockerfile new file mode 100644 index 000000000..98d79e9ef --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.4/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.4/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.2.4/Dockerfile.jdk11 new file mode 100644 index 000000000..8fc573cbe --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.4/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.4/Makefile b/linux/ecosystem/atlassian/crowd/5/5.2.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.4/README.md b/linux/ecosystem/atlassian/crowd/5/5.2.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.2.4/docker-compose.yml new file mode 100644 index 000000000..9dc0db774 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.2.4" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.2.4-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.2.4-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.2.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.6/.env b/linux/ecosystem/atlassian/crowd/5/5.2.6/.env new file mode 100644 index 000000000..b4d71e000 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.6/.env @@ -0,0 +1,3 @@ +RELEASE=5.2.6 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.6/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.2.6/Dockerfile new file mode 100644 index 000000000..f9c01dc27 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.6/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.6/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.2.6/Dockerfile.jdk11 new file mode 100644 index 000000000..6bcc6aebd --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.6/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.6/Makefile b/linux/ecosystem/atlassian/crowd/5/5.2.6/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.6/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.6/README.md b/linux/ecosystem/atlassian/crowd/5/5.2.6/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.6/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.6/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.2.6/docker-compose.yml new file mode 100644 index 000000000..36396d91b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.6/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.2.6" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.2.6-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.2.6-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.6/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.2.6/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.6/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.7/.env b/linux/ecosystem/atlassian/crowd/5/5.2.7/.env new file mode 100644 index 000000000..d6488a725 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.7/.env @@ -0,0 +1,3 @@ +RELEASE=5.2.7 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.7/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.2.7/Dockerfile new file mode 100644 index 000000000..96b03217d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.7/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.7/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.2.7/Dockerfile.jdk11 new file mode 100644 index 000000000..53e453a70 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.7/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.7/Makefile b/linux/ecosystem/atlassian/crowd/5/5.2.7/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.7/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.7/README.md b/linux/ecosystem/atlassian/crowd/5/5.2.7/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.7/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.7/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.2.7/docker-compose.yml new file mode 100644 index 000000000..eec0beb2b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.7/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.2.7" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.2.7-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.2.7-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.7/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.2.7/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.7/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.8/.env b/linux/ecosystem/atlassian/crowd/5/5.2.8/.env new file mode 100644 index 000000000..470d431bc --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.8/.env @@ -0,0 +1,3 @@ +RELEASE=5.2.8 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.8/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.2.8/Dockerfile new file mode 100644 index 000000000..c50c33a97 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.8/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.8/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.2.8/Dockerfile.jdk11 new file mode 100644 index 000000000..e7bf2bb9c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.8/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.8 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.8/Makefile b/linux/ecosystem/atlassian/crowd/5/5.2.8/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.8/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.8/README.md b/linux/ecosystem/atlassian/crowd/5/5.2.8/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.8/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.8/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.2.8/docker-compose.yml new file mode 100644 index 000000000..920648fb5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.8/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.2.8" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.2.8-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.2.8-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.8/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.2.8/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.8/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.9/.env b/linux/ecosystem/atlassian/crowd/5/5.2.9/.env new file mode 100644 index 000000000..69ad2f3cb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.9/.env @@ -0,0 +1,3 @@ +RELEASE=5.2.9 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.9/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.2.9/Dockerfile new file mode 100644 index 000000000..fcba8afcd --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.9/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.9/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.2.9/Dockerfile.jdk11 new file mode 100644 index 000000000..2e450472a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.9/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.2.9 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.9/Makefile b/linux/ecosystem/atlassian/crowd/5/5.2.9/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.9/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.9/README.md b/linux/ecosystem/atlassian/crowd/5/5.2.9/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.9/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.9/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.2.9/docker-compose.yml new file mode 100644 index 000000000..9b35ec2c9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.9/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.2.9" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.2.9-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.2.9-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.2.9/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.2.9/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.2.9/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.0/.env b/linux/ecosystem/atlassian/crowd/5/5.3.0/.env new file mode 100644 index 000000000..c43e1bf9e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.0/.env @@ -0,0 +1,3 @@ +RELEASE=5.3.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.0/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.3.0/Dockerfile new file mode 100644 index 000000000..700bd7ae0 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.3.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.0/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.3.0/Dockerfile.jdk11 new file mode 100644 index 000000000..1b8888960 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.0/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.3.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.0/Makefile b/linux/ecosystem/atlassian/crowd/5/5.3.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.0/README.md b/linux/ecosystem/atlassian/crowd/5/5.3.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.3.0/docker-compose.yml new file mode 100644 index 000000000..fe5fd8703 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.0/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.3.0" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.3.0-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.3.0-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.3.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.1/.env b/linux/ecosystem/atlassian/crowd/5/5.3.1/.env new file mode 100644 index 000000000..e7121b73f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.1/.env @@ -0,0 +1,3 @@ +RELEASE=5.3.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.1/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.3.1/Dockerfile new file mode 100644 index 000000000..4900fd4c3 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.1/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.3.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.1/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.3.1/Dockerfile.jdk11 new file mode 100644 index 000000000..cc9aecf67 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.1/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.3.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.1/Makefile b/linux/ecosystem/atlassian/crowd/5/5.3.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.1/README.md b/linux/ecosystem/atlassian/crowd/5/5.3.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.3.1/docker-compose.yml new file mode 100644 index 000000000..b9d97dd22 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.1/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.3.1" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.3.1-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.3.1-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.3.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.2/.env b/linux/ecosystem/atlassian/crowd/5/5.3.2/.env new file mode 100644 index 000000000..4aadda944 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.2/.env @@ -0,0 +1,3 @@ +RELEASE=5.3.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.2/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.3.2/Dockerfile new file mode 100644 index 000000000..dfc5553de --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.3.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.2/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.3.2/Dockerfile.jdk11 new file mode 100644 index 000000000..0930f12da --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.2/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.3.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.2/Makefile b/linux/ecosystem/atlassian/crowd/5/5.3.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.2/README.md b/linux/ecosystem/atlassian/crowd/5/5.3.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.3.2/docker-compose.yml new file mode 100644 index 000000000..9a384c2ed --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.2/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.3.2" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.3.2-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.3.2-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.3.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.3/.env b/linux/ecosystem/atlassian/crowd/5/5.3.3/.env new file mode 100644 index 000000000..844c9d4bb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.3/.env @@ -0,0 +1,3 @@ +RELEASE=5.3.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.3/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.3.3/Dockerfile new file mode 100644 index 000000000..68e26d43a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.3.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.3/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.3.3/Dockerfile.jdk11 new file mode 100644 index 000000000..1d9018ebb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.3/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.3.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.3/Makefile b/linux/ecosystem/atlassian/crowd/5/5.3.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.3/README.md b/linux/ecosystem/atlassian/crowd/5/5.3.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.3.3/docker-compose.yml new file mode 100644 index 000000000..3d5b012d7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.3/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.3.3" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.3.3-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.3.3-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.3.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.4/.env b/linux/ecosystem/atlassian/crowd/5/5.3.4/.env new file mode 100644 index 000000000..ef7b64280 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.4/.env @@ -0,0 +1,3 @@ +RELEASE=5.3.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.4/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.3.4/Dockerfile new file mode 100644 index 000000000..1b2d9436d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.4/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.3.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.4/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.3.4/Dockerfile.jdk11 new file mode 100644 index 000000000..65950c4ac --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.4/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.3.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.4/Makefile b/linux/ecosystem/atlassian/crowd/5/5.3.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.4/README.md b/linux/ecosystem/atlassian/crowd/5/5.3.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.3.4/docker-compose.yml new file mode 100644 index 000000000..e538149f1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.4/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.3.4" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.3.4-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.3.4-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.3.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.5/.env b/linux/ecosystem/atlassian/crowd/5/5.3.5/.env new file mode 100644 index 000000000..ff36cf628 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.5/.env @@ -0,0 +1,3 @@ +RELEASE=5.3.5 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.5/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.3.5/Dockerfile new file mode 100644 index 000000000..a5952d0bf --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.5/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.3.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.5/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.3.5/Dockerfile.jdk11 new file mode 100644 index 000000000..3f0aba734 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.5/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.3.5 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.5/Makefile b/linux/ecosystem/atlassian/crowd/5/5.3.5/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.5/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.5/README.md b/linux/ecosystem/atlassian/crowd/5/5.3.5/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.5/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.5/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.3.5/docker-compose.yml new file mode 100644 index 000000000..ddcc9dc7a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.5/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.3.5" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.3.5-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.3.5-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.5/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.3.5/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.5/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.6/.env b/linux/ecosystem/atlassian/crowd/5/5.3.6/.env new file mode 100644 index 000000000..788536dd5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.6/.env @@ -0,0 +1,3 @@ +RELEASE=5.3.6 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.6/Dockerfile b/linux/ecosystem/atlassian/crowd/5/5.3.6/Dockerfile new file mode 100644 index 000000000..d98dcea4c --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.6/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk8 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.3.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.6/Dockerfile.jdk11 b/linux/ecosystem/atlassian/crowd/5/5.3.6/Dockerfile.jdk11 new file mode 100644 index 000000000..9cb5df7ed --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.6/Dockerfile.jdk11 @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk11 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=5.3.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.6/Makefile b/linux/ecosystem/atlassian/crowd/5/5.3.6/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.6/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.6/README.md b/linux/ecosystem/atlassian/crowd/5/5.3.6/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.6/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.6/docker-compose.yml b/linux/ecosystem/atlassian/crowd/5/5.3.6/docker-compose.yml new file mode 100644 index 000000000..1e878a975 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.6/docker-compose.yml @@ -0,0 +1,14 @@ +services: + app: + image: "epicmorg/crowd:5.3.6" + build: + context: . + app-jdk8: + image: "epicmorg/crowd:5.3.6-jdk8" + build: + context: . + app-jdk11: + image: "epicmorg/crowd:5.3.6-jdk11" + build: + context: . + dockerfile: Dockerfile.jdk11 diff --git a/linux/ecosystem/atlassian/crowd/5/5.3.6/entrypoint.sh b/linux/ecosystem/atlassian/crowd/5/5.3.6/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/5/5.3.6/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.0/.env b/linux/ecosystem/atlassian/crowd/6/6.0.0/.env new file mode 100644 index 000000000..4c94467be --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.0/.env @@ -0,0 +1,3 @@ +RELEASE=6.0.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.0/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.0.0/Dockerfile new file mode 100644 index 000000000..07db286e8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.0.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.0/Makefile b/linux/ecosystem/atlassian/crowd/6/6.0.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.0/README.md b/linux/ecosystem/atlassian/crowd/6/6.0.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.0.0/docker-compose.yml new file mode 100644 index 000000000..686b6e0e8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.0/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.0.0" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.0.0-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.0.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.1/.env b/linux/ecosystem/atlassian/crowd/6/6.0.1/.env new file mode 100644 index 000000000..64a3f8972 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.1/.env @@ -0,0 +1,3 @@ +RELEASE=6.0.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.1/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.0.1/Dockerfile new file mode 100644 index 000000000..d65df471b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.1/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.0.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.1/Makefile b/linux/ecosystem/atlassian/crowd/6/6.0.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.1/README.md b/linux/ecosystem/atlassian/crowd/6/6.0.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.0.1/docker-compose.yml new file mode 100644 index 000000000..7b51549e7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.1/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.0.1" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.0.1-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.0.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.2/.env b/linux/ecosystem/atlassian/crowd/6/6.0.2/.env new file mode 100644 index 000000000..7bbdd6445 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.2/.env @@ -0,0 +1,3 @@ +RELEASE=6.0.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.2/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.0.2/Dockerfile new file mode 100644 index 000000000..25832d28e --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.0.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.2/Makefile b/linux/ecosystem/atlassian/crowd/6/6.0.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.2/README.md b/linux/ecosystem/atlassian/crowd/6/6.0.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.0.2/docker-compose.yml new file mode 100644 index 000000000..2c1848a64 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.2/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.0.2" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.0.2-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.0.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.3/.env b/linux/ecosystem/atlassian/crowd/6/6.0.3/.env new file mode 100644 index 000000000..aa6295f0d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.3/.env @@ -0,0 +1,3 @@ +RELEASE=6.0.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.3/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.0.3/Dockerfile new file mode 100644 index 000000000..748d0774f --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.0.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.3/Makefile b/linux/ecosystem/atlassian/crowd/6/6.0.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.3/README.md b/linux/ecosystem/atlassian/crowd/6/6.0.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.0.3/docker-compose.yml new file mode 100644 index 000000000..a896a1fad --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.3/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.0.3" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.0.3-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.0.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.4/.env b/linux/ecosystem/atlassian/crowd/6/6.0.4/.env new file mode 100644 index 000000000..be7a11efc --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.4/.env @@ -0,0 +1,3 @@ +RELEASE=6.0.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.4/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.0.4/Dockerfile new file mode 100644 index 000000000..a78946567 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.4/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.0.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.4/Makefile b/linux/ecosystem/atlassian/crowd/6/6.0.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.4/README.md b/linux/ecosystem/atlassian/crowd/6/6.0.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.0.4/docker-compose.yml new file mode 100644 index 000000000..8763c0ff7 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.4/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.0.4" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.0.4-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.0.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.6/.env b/linux/ecosystem/atlassian/crowd/6/6.0.6/.env new file mode 100644 index 000000000..542b916f1 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.6/.env @@ -0,0 +1,3 @@ +RELEASE=6.0.6 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.6/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.0.6/Dockerfile new file mode 100644 index 000000000..6ae41afca --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.6/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.0.6 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.6/Makefile b/linux/ecosystem/atlassian/crowd/6/6.0.6/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.6/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.6/README.md b/linux/ecosystem/atlassian/crowd/6/6.0.6/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.6/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.6/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.0.6/docker-compose.yml new file mode 100644 index 000000000..a101727da --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.6/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.0.6" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.0.6-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.6/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.0.6/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.6/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.7/.env b/linux/ecosystem/atlassian/crowd/6/6.0.7/.env new file mode 100644 index 000000000..71a9da212 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.7/.env @@ -0,0 +1,3 @@ +RELEASE=6.0.7 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.7/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.0.7/Dockerfile new file mode 100644 index 000000000..73ba7d688 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.7/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.0.7 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.7/Makefile b/linux/ecosystem/atlassian/crowd/6/6.0.7/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.7/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.7/README.md b/linux/ecosystem/atlassian/crowd/6/6.0.7/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.7/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.7/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.0.7/docker-compose.yml new file mode 100644 index 000000000..6067917ae --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.7/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.0.7" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.0.7-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.0.7/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.0.7/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.0.7/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.0/.env b/linux/ecosystem/atlassian/crowd/6/6.1.0/.env new file mode 100644 index 000000000..47062d5b9 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.0/.env @@ -0,0 +1,3 @@ +RELEASE=6.1.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.0/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.1.0/Dockerfile new file mode 100644 index 000000000..403861b35 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.1.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.0/Makefile b/linux/ecosystem/atlassian/crowd/6/6.1.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.0/README.md b/linux/ecosystem/atlassian/crowd/6/6.1.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.1.0/docker-compose.yml new file mode 100644 index 000000000..576c8e1ed --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.0/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.1.0" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.1.0-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.1.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.1/.env b/linux/ecosystem/atlassian/crowd/6/6.1.1/.env new file mode 100644 index 000000000..4781a42fc --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.1/.env @@ -0,0 +1,3 @@ +RELEASE=6.1.1 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.1/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.1.1/Dockerfile new file mode 100644 index 000000000..ab7eb2613 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.1/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.1.1 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.1/Makefile b/linux/ecosystem/atlassian/crowd/6/6.1.1/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.1/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.1/README.md b/linux/ecosystem/atlassian/crowd/6/6.1.1/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.1/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.1/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.1.1/docker-compose.yml new file mode 100644 index 000000000..a9569c19d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.1/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.1.1" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.1.1-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.1/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.1.1/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.1/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.2/.env b/linux/ecosystem/atlassian/crowd/6/6.1.2/.env new file mode 100644 index 000000000..ececb7842 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.2/.env @@ -0,0 +1,3 @@ +RELEASE=6.1.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.2/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.1.2/Dockerfile new file mode 100644 index 000000000..e51f46e6b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.1.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.2/Makefile b/linux/ecosystem/atlassian/crowd/6/6.1.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.2/README.md b/linux/ecosystem/atlassian/crowd/6/6.1.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.1.2/docker-compose.yml new file mode 100644 index 000000000..9d87a2c6d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.2/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.1.2" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.1.2-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.1.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.3/.env b/linux/ecosystem/atlassian/crowd/6/6.1.3/.env new file mode 100644 index 000000000..c2239afa2 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.3/.env @@ -0,0 +1,3 @@ +RELEASE=6.1.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.3/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.1.3/Dockerfile new file mode 100644 index 000000000..b318d337b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.1.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.3/Makefile b/linux/ecosystem/atlassian/crowd/6/6.1.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.3/README.md b/linux/ecosystem/atlassian/crowd/6/6.1.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.1.3/docker-compose.yml new file mode 100644 index 000000000..5ca74e79d --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.3/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.1.3" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.1.3-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.1.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.4/.env b/linux/ecosystem/atlassian/crowd/6/6.1.4/.env new file mode 100644 index 000000000..c9a976663 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.4/.env @@ -0,0 +1,3 @@ +RELEASE=6.1.4 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.4/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.1.4/Dockerfile new file mode 100644 index 000000000..2945342e5 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.4/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.1.4 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.4/Makefile b/linux/ecosystem/atlassian/crowd/6/6.1.4/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.4/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.4/README.md b/linux/ecosystem/atlassian/crowd/6/6.1.4/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.4/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.4/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.1.4/docker-compose.yml new file mode 100644 index 000000000..c58469edc --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.4/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.1.4" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.1.4-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.1.4/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.1.4/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.1.4/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.0/.env b/linux/ecosystem/atlassian/crowd/6/6.2.0/.env new file mode 100644 index 000000000..dd2ab2bcf --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.0/.env @@ -0,0 +1,3 @@ +RELEASE=6.2.0 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.0/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.2.0/Dockerfile new file mode 100644 index 000000000..665921872 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.0/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.2.0 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.0/Makefile b/linux/ecosystem/atlassian/crowd/6/6.2.0/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.0/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.0/README.md b/linux/ecosystem/atlassian/crowd/6/6.2.0/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.0/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.0/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.2.0/docker-compose.yml new file mode 100644 index 000000000..d354a1909 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.0/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.2.0" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.2.0-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.0/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.2.0/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.0/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.2/.env b/linux/ecosystem/atlassian/crowd/6/6.2.2/.env new file mode 100644 index 000000000..a918a5667 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.2/.env @@ -0,0 +1,3 @@ +RELEASE=6.2.2 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.2/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.2.2/Dockerfile new file mode 100644 index 000000000..1a358e447 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.2/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.2.2 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.2/Makefile b/linux/ecosystem/atlassian/crowd/6/6.2.2/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.2/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.2/README.md b/linux/ecosystem/atlassian/crowd/6/6.2.2/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.2/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.2/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.2.2/docker-compose.yml new file mode 100644 index 000000000..6de1494a8 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.2/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.2.2" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.2.2-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.2/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.2.2/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.2/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.3/.env b/linux/ecosystem/atlassian/crowd/6/6.2.3/.env new file mode 100644 index 000000000..13d032163 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.3/.env @@ -0,0 +1,3 @@ +RELEASE=6.2.3 +DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.3/Dockerfile b/linux/ecosystem/atlassian/crowd/6/6.2.3/Dockerfile new file mode 100644 index 000000000..0703a68dc --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.3/Dockerfile @@ -0,0 +1,85 @@ +FROM epicmorg/debian:bookworm-jdk17 +LABEL maintainer="Atlassian Crowd Server Team; EpicMorg DevTeam, developer@epicm.org" +ARG DEBIAN_FRONTEND=noninteractive + +################################################################## +# ARGuments +################################################################## +ARG RELEASE=6.2.3 +ARG DOWNLOAD_URL=https://www.atlassian.com/software/crowd/downloads/binary/atlassian-crowd-${RELEASE}.tar.gz +ARG TEMP_ARCHIVE=/tmp/atlassian-crowd-${RELEASE}.tar.gz + +################################################################## +# Setup +################################################################## +ENV RUN_USER daemon +ENV RUN_GROUP daemon +ENV APP_NAME crowd + +#2004 +#ENV RUN_UID 0 +#ENV RUN_GID 0 + +# https://confluence.atlassian.com/crowd/important-directories-and-files-78676537.html +ENV CROWD_HOME /var/atlassian/application-data/crowd +ENV CROWD_INSTALL_DIR /opt/atlassian/crowd +ENV CROWD_DB ${CROWD_INSTALL_DIR}/database + +################################################################## +# Installing +################################################################## +ADD ${DOWNLOAD_URL} /tmp + +RUN apt-get update && \ + apt-get upgrade -y && \ + apt-get install -y --no-install-recommends fontconfig python3 python3-jinja2 tini && \ + apt-get clean autoclean && apt-get autoremove -y && rm -rf /var/lib/apt/lists/* + +RUN mkdir -p ${CROWD_INSTALL_DIR} ${CROWD_DB} /opt/atlassian/support /opt/atlassian/etc && \ + tar -xvzf ${TEMP_ARCHIVE} --strip-components=1 --directory "${CROWD_INSTALL_DIR}" && \ + sed -i -e 's/-Xms\([0-9]\+[kmg]\) -Xmx\([0-9]\+[kmg]\)/-Xms\${JVM_MINIMUM_MEMORY:=\1} -Xmx\${JVM_MAXIMUM_MEMORY:=\2} \${JVM_SUPPORT_RECOMMENDED_ARGS} -Dcrowd.home=\${CROWD_HOME}/g' ${CROWD_INSTALL_DIR}/apache-tomcat/bin/setenv.sh && \ + sed -i -e 's/port="8095"/port="8095" secure="${catalinaConnectorSecure}" scheme="${catalinaConnectorScheme}" proxyName="${catalinaConnectorProxyName}" proxyPort="${catalinaConnectorProxyPort}"/' ${CROWD_INSTALL_DIR}/apache-tomcat/conf/server.xml && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +COPY entrypoint.sh / +#COPY shutdown-wait.sh / +#COPY shared-components/image/entrypoint_helpers.py / +#COPY shared-components/support /opt/atlassian/support +#COPY config/* /opt/atlassian/etc/ + +RUN chmod +x /entrypoint.sh && \ +# chmod +x /entrypoint.py && \ +# chmod +x /shutdown-wait.sh && \ +# chmod +x /entrypoint_helpers.py && \ + chown -R ${RUN_USER}:${RUN_GROUP} ${CROWD_INSTALL_DIR} + +################################################################## +# cleanup +################################################################## +RUN echo "clean up" && \ + apt-get clean -y && \ + apt-get autoremove -y && \ + apt-get autoclean -y && \ + rm -rfv /var/lib/apt/lists/* && \ + rm -rfv /var/cache/apt/archives/*.deb && \ + rm -rfv /root/tmp/* && \ + rm -rfv /tmp/* + +# Expose HTTP port +EXPOSE 8095 + +VOLUME ["${CROWD_HOME}"] # Must be declared after setting perms +VOLUME ["${CROWD_DB}"] # Must be declared after setting perms +WORKDIR ${CROWD_HOME} + +CMD ["/entrypoint.sh", "-fg"] +#CMD ["/entrypoint.py"] +ENTRYPOINT ["/usr/bin/tini", "--"] + +RUN updatedb diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.3/Makefile b/linux/ecosystem/atlassian/crowd/6/6.2.3/Makefile new file mode 100644 index 000000000..b5e50619b --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.3/Makefile @@ -0,0 +1,38 @@ +PIP_BREAK_SYSTEM_PACKAGES=1 + +all: app + +app: + make build + make deploy + make clean + + +build: + buildah-wrapper --build + +deploy: + buildah-wrapper --deploy + + +build-kaniko: + kaniko-wrapper --kaniko-image gcr.io/kaniko-project/executor:debug --dry-run + +deploy-kaniko: + kaniko-wrapper --deploy --kaniko-image gcr.io/kaniko-project/executor:debug + +build-compose: + docker-compose build --compress --parallel --progress plain + + +deploy-compose: + docker-compose push + +clean: + docker container prune -f + docker image prune -f + docker network prune -f + docker volume prune -f + docker system prune -af + buildah rm -a + buildah rmi -a diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.3/README.md b/linux/ecosystem/atlassian/crowd/6/6.2.3/README.md new file mode 100644 index 000000000..3bdc16057 --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.3/README.md @@ -0,0 +1,311 @@ +![Atlassian Crowd](https://wac-cdn.atlassian.com/dam/jcr:d2a1da52-ae52-4b06-9ab1-da8647a89653/crowd-icon-gradient-blue.svg?cdnVersion=696) + +Crowd provides single sign-on and user identity that's easy to use. + +Learn more about Crowd: [https://www.atlassian.com/software/crowd][1] + +# Contents + +[TOC] + +# Overview + +This Docker container makes it easy to get an instance of Crowd up and running. + +Note: ** Use docker version >= 20.10.10 ** + +# Quick Start + +For the `CROWD_HOME` directory that is used to store application data (amongst other things) we recommend mounting a host directory as a [data volume](https://docs.docker.com/engine/tutorials/dockervolumes/#/data-volumes), or via a named volume. + +To get started you can use a data volume, or named volumes. In this example we'll use named volumes. + + docker volume create --name crowdVolume + docker run -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + + +**Success**. Crowd is now available on [http://localhost:8095](http://localhost:8095)* + +Please ensure your container has the necessary resources allocated to it. See [Supported Platforms][2] for further information. + + +_* Note: If you are using `docker-machine` on Mac OS X, please use `open http://$(docker-machine ip default):8095` instead._ + +## Memory / Heap Size + +If you need to override Crowd's default memory allocation, you can control the minimum heap (Xms) and maximum heap (Xmx) via the below environment variables. + +* `JVM_MINIMUM_MEMORY` (default: 384m) + + The minimum heap size of the JVM + +* `JVM_MAXIMUM_MEMORY` (default: 768m) + + The maximum heap size of the JVM + +## Reverse Proxy Settings + +If Crowd is run behind a reverse proxy server as [described here][3], then you need to specify extra options to make Crowd aware of the setup. They can be controlled via the below environment variables. + +* `ATL_PROXY_NAME` (default: NONE) + + The reverse proxy's fully qualified hostname. `CATALINA_CONNECTOR_PROXYNAME` + is also supported for backwards compatability. + +* `ATL_PROXY_PORT` (default: NONE) + + The reverse proxy's port number via which Crowd is + accessed. `CATALINA_CONNECTOR_PROXYPORT` is also supported for backwards + compatability. + +* `ATL_TOMCAT_PORT` (default: 8095) + + The port for Tomcat/Crowd to listen on. Depending on your container + deployment method this port may need to be + [exposed and published][docker-expose]. + +* `ATL_TOMCAT_SCHEME` (default: http) + + The protocol via which Crowd is accessed. `CATALINA_CONNECTOR_SCHEME` is also + supported for backwards compatability. + +* `ATL_TOMCAT_SECURE` (default: false) + + Set 'true' if `ATL_TOMCAT_SCHEME` is 'https'. `CATALINA_CONNECTOR_SECURE` is + also supported for backwards compatability. + +The following Tomcat/Catalina options are also supported. For more information, +see https://tomcat.apache.org/tomcat-8.5-doc/config/index.html. + +* `ATL_TOMCAT_MGMT_PORT` (default: 8000) +* `ATL_TOMCAT_MAXTHREADS` (default: 100) +* `ATL_TOMCAT_MINSPARETHREADS` (default: 10) +* `ATL_TOMCAT_CONNECTIONTIMEOUT` (default: 20000) +* `ATL_TOMCAT_ENABLELOOKUPS` (default: false) +* `ATL_TOMCAT_PROTOCOL` (default: HTTP/1.1) +* `ATL_TOMCAT_ACCEPTCOUNT` (default: 10) +* `ATL_TOMCAT_MAXHTTPHEADERSIZE` (default: 8192) + +## JVM Configuration + +If you need to pass additional JVM arguments to Crowd, such as specifying a custom trust store, you can add them via the below environment variable + +* `JVM_SUPPORT_RECOMMENDED_ARGS` + + Additional JVM arguments for Crowd + +Example: + + docker run -e JVM_SUPPORT_RECOMMENDED_ARGS=-Djavax.net.ssl.trustStore=/var/atlassian/application-data/crowd/cacerts -v crowdVolume:/var/atlassian/application-data/crowd --name="crowd" -d -p 8095:8095 atlassian/crowd + +## Data Center configuration + +This docker image can be run as part of a [Data Center][4] cluster. You can +specify the following properties to start Crowd as a Data Center node, +instead of manually configuring a cluster. See [Installing Crowd Data +Center][5] for more information. + +## Container Configuration + +* `SET_PERMISSIONS` (default: true) + + Define whether to set home directory permissions on startup. Set to `false` to disable + this behaviour. + +## Advanced Configuration + +As mentioned at the top of this section, the settings from the environment are +used to populate the application configuration on the container startup. However +in some cases you may wish to customise the settings in ways that are not +supported by the environment variables above. In this case, it is possible to +modify the base templates to add your own configuration. There are three main +ways of doing this; modify our repository to your own image, build a new image +from the existing one, or provide new templates at startup. We will briefly +outline this methods here, but in practice how you do this will depend on your +needs. + +#### Building your own image + +* Clone the Atlassian repository at https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/ +* Modify or replace the [Jinja](https://jinja.palletsprojects.com/) templates + under `config`; _NOTE_: The files must have the `.j2` extensions. However you + don't have to use template variables if you don't wish. +* Build the new image with e.g: `docker build --tag my-crowd-image --build-arg CROWD_VERSION=3.x.x .` +* Optionally push to a registry, and deploy. + +#### Build a new image from the existing one + +* Create a new `Dockerfile`, which starts with the Atlassian Crowd base image e.g: `FROM atlassian/crowd:latest`. +* Use a `COPY` line to overwrite the provided templates. +* Build, push and deploy the new image as above. + +#### Overwrite the templates at runtime + +There are two main ways of doing this: + +* If your container is going to be long-lived, you can create it, modify the + installed templates under `/opt/atlassian/etc/`, and then run it. +* Alternatively, you can create a volume containing your alternative templates, + and mount it over the provided templates at runtime + with `--volume my-config:/opt/atlassian/etc/`. + +# Shared directory and user IDs + +By default the Crowd application runs as the user `crowd`, with a UID +and GID of 2004. Consequently this UID must have write access to the shared +filesystem. If for some reason a different UID must be used, there are a number +of options available: + +* The Docker image can be rebuilt with a different UID. +* Under Linux, the UID can be remapped using + [user namespace remapping][7]. + +To preserve strict permissions for certain configuration files, this container starts as +`root` to perform bootstrapping before running Crowd under a non-privileged user +account. If you wish to start the container as a non-root user, please note that Tomcat +configuration will be skipped and a warning will be logged. You may still apply custom +configuration in this situation by mounting configuration files directly, e.g. +by mounting your own server.xml file directly to +`/opt/atlassian/crowd/apache-tomcat/conf/server.xml` + +# Upgrade + +To upgrade to a more recent version of Crowd you can simply stop the `crowd` container and start a new one based on a more recent image: + + docker stop crowd + docker rm crowd + docker run ... (See above) + +As your data is stored in the data volume directory on the host it will still be available after the upgrade. + +_Note: Please make sure that you **don't** accidentally remove the `crowd` container and its volumes using the `-v` option._ + +# Backup + +For evaluations you can use the built-in database that will store its files in the Crowd home directory. In that case it is sufficient to create a backup archive of the docker volume. + +If you're using an external database, you can configure Crowd to make a backup automatically each night. This will back up the current state, including the database to the `crowdVolume` docker volume, which can then be archived. Alternatively you can backup the database separately, and continue to create a backup archive of the docker volume to back up the Crowd Home directory. + +Read more about data recovery and backups: [Backing Up and Restoring Data][6] + +# Versioning + +The `latest` tag matches the most recent release of Atlassian Crowd. Thus `atlassian/crowd:latest` will use the newest version of Crowd available. + +Alternatively you can use a specific major, major.minor, or major.minor.patch version of Crowd by using a version number tag: + +* `atlassian/crowd:3` +* `atlassian/crowd:3.2` +* `atlassian/crowd:3.2.3` + +All versions from 3.0+ are available + +# Supported JDK versions + +All the Atlassian Docker images are now JDK11 only, and generated from the +[official Eclipse Temurin OpenJDK Docker images](https://hub.docker.com/_/eclipse-temurin). + +The Docker images follow the [Atlassian Support end-of-life +policy](https://confluence.atlassian.com/support/atlassian-support-end-of-life-policy-201851003.html); +images for unsupported versions of the products remain available but will no longer +receive updates or fixes. + +Historically, we have also generated other versions of the images, including +JDK8, Alpine, and 'slim' versions of the JDK. These legacy images still exist in +Docker Hub, however they should be considered deprecated, and do not receive +updates or fixes. + +If for some reason you need a different version, see "Building your own image" +above. + +# Supported architectures + +Currently the Atlassian Docker images are built for the `linux/amd64` target +platform; we do not have other architectures on our roadmap at this +point. However the Dockerfiles and support tooling have now had all +architecture-specific components removed, so if necessary it is possible to +build images for any platform supported by Docker. + +## Building on the target architecture + +Note: This method is known to work on Mac M1 and AWS ARM64 machines, but has not +be extensively tested. + +The simplest method of getting a platform image is to build it on a target +machine. The following assumes you have git and Docker installed. You will also +need to know which version of Crowd you want to build; substitute +`CROWD_VERSION=x.x.x` with your required version: + +``` +git clone --recurse-submodule https://bitbucket.org/atlassian-docker/docker-atlassian-crowd.git +cd docker-atlassian-crowd +docker build --tag my-image --build-arg CROWD_VERSION=x.x.x . +``` +This image can be pushed up to your own Docker Hub or private repository. + +# Troubleshooting + +These images include built-in scripts to assist in performing common JVM diagnostic tasks. + +## Thread dumps + +`/opt/atlassian/support/thread-dumps.sh` can be run via `docker exec` to easily trigger the collection of thread +dumps from the containerized application. For example: + + docker exec my_crowd /opt/atlassian/support/thread-dumps.sh + +By default this script will collect 10 thread dumps at 5 second intervals. This can +be overridden by passing a custom value for the count and interval, by using `-c` / `--count` +and `-i` / `--interval` respectively. For example, to collect 20 thread dumps at 3 second intervals: + + docker exec my_container /opt/atlassian/support/thread-dumps.sh --count 20 --interval 3 + +Thread dumps will be written to `$APP_HOME/thread_dumps/`. + +Note: By default this script will also capture output from top run in 'Thread-mode'. This can +be disabled by passing `-n` / `--no-top` + +## Heap dump + +`/opt/atlassian/support/heap-dump.sh` can be run via `docker exec` to easily trigger the collection of a heap +dump from the containerized application. For example: + + docker exec my_container /opt/atlassian/support/heap-dump.sh + +A heap dump will be written to `$APP_HOME/heap.bin`. If a file already exists at this +location, use `-f` / `--force` to overwrite the existing heap dump file. + +## Manual diagnostics + +The `jcmd` utility is also included in these images and can be used by starting a `bash` shell +in the running container: + + docker exec -it my_container /bin/bash + +# Support + +For product support, go to: + +* https://support.atlassian.com/crowd/ + +You can also visit the [Atlassian Data Center on +Kubernetes](https://community.atlassian.com/t5/Atlassian-Data-Center-on/gh-p/DC_Kubernetes) +forum for discussion on running Atlassian Data Center products in containers. + +# Changelog + +For a detailed list of changes to the Docker image configuration see [the Git +commit history](https://bitbucket.org/atlassian-docker/docker-atlassian-crowd/commits/). + +# License + +Copyright © 2019 Atlassian Corporation Pty Ltd. +Licensed under the Apache License, Version 2.0. + +[1]: https://www.atlassian.com/software/crowd +[2]: https://confluence.atlassian.com/crowd/supported-platforms-191851.html +[3]: https://confluence.atlassian.com/crowd031/integrating-crowd-with-apache-949753124.html +[4]: https://confluence.atlassian.com/crowd/crowd-data-center-935372453.html +[5]: https://confluence.atlassian.com/crowd/installing-crowd-data-center-935369773.html +[6]: https://confluence.atlassian.com/crowd/backing-up-and-restoring-data-36470797.html +[7]: https://docs.docker.com/engine/security/userns-remap/ diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.3/docker-compose.yml b/linux/ecosystem/atlassian/crowd/6/6.2.3/docker-compose.yml new file mode 100644 index 000000000..b9ebb6ffb --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.3/docker-compose.yml @@ -0,0 +1,9 @@ +services: + app: + image: "epicmorg/crowd:6.2.3" + build: + context: . + app-jdk17: + image: "epicmorg/crowd:6.2.3-jdk17" + build: + context: . diff --git a/linux/ecosystem/atlassian/crowd/6/6.2.3/entrypoint.sh b/linux/ecosystem/atlassian/crowd/6/6.2.3/entrypoint.sh new file mode 100755 index 000000000..66f97b77a --- /dev/null +++ b/linux/ecosystem/atlassian/crowd/6/6.2.3/entrypoint.sh @@ -0,0 +1,37 @@ +#!/bin/bash +set -euo pipefail + +# Setup Catalina Opts +: ${CATALINA_CONNECTOR_PROXYNAME:=} +: ${CATALINA_CONNECTOR_PROXYPORT:=} +: ${CATALINA_CONNECTOR_SCHEME:=http} +: ${CATALINA_CONNECTOR_SECURE:=false} + +: ${CATALINA_OPTS:=} + +: ${JAVA_OPTS:=} + +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyName=${CATALINA_CONNECTOR_PROXYNAME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorProxyPort=${CATALINA_CONNECTOR_PROXYPORT}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorScheme=${CATALINA_CONNECTOR_SCHEME}" +CATALINA_OPTS="${CATALINA_OPTS} -DcatalinaConnectorSecure=${CATALINA_CONNECTOR_SECURE}" + +export JAVA_OPTS="${JAVA_OPTS} ${CATALINA_OPTS}" + + +# Start Bamboo as the correct user +if [ "${UID}" -eq 0 ]; then + echo "User is currently root. Will change directory ownership to ${RUN_USER}:${RUN_GROUP}, then downgrade permission to ${RUN_USER}" + PERMISSIONS_SIGNATURE=$(stat -c "%u:%U:%a" "${CROWD_HOME}") + EXPECTED_PERMISSIONS=$(id -u ${RUN_USER}):${RUN_USER}:700 + if [ "${PERMISSIONS_SIGNATURE}" != "${EXPECTED_PERMISSIONS}" ]; then + chmod -R 700 "${CROWD_HOME}" && + chown -R "${RUN_USER}:${RUN_GROUP}" "${CROWD_HOME}" + fi + # Now drop privileges + cd /opt/atlassian/crowd + exec su -s /bin/bash "${RUN_USER}" -c "$CROWD_INSTALL_DIR/start_crowd.sh $@" +else + cd /opt/atlassian/crowd + exec "$CROWD_INSTALL_DIR/start_crowd.sh" "$@" +fi