Reduce fetch depth #none

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,28 @@
+---
+name: Bug Report
+about: Use this to report a new bug
+
+---
+
+### Expected Behavior
+<!--- Tell us what should happen -->
+
+### Current Behavior
+<!--- Tell us what happens instead of the expected behavior -->
+
+### Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+
+### Steps to Reproduce
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+3.
+4.
+
+### Context (Environment)
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+
+<!--- Provide a general summary of the issue in the Title above -->

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,14 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+
+---
+
+### Description
+<!-- What use case are you trying to solve with this feature -->
+
+### Proposed solution
+<!-- A clear and concise description of what you want to happen -->
+
+### Definition of Done
+<!-- How to know this is implemeted. Preferably one short sentence -->

.github/ISSUE_TEMPLATE/new-sprint-task.md

@@ -0,0 +1,14 @@
+---
+name: Sprint Task
+about: Use when creating a new task in a sprint
+
+---
+
+### Description
+<!-- What are you working on -->
+
+### Definition of Done
+<!-- How to know when the task is done. -->
+
+### How to test
+<!-- How can someone else verify the task, can be test-suite or something else -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,39 @@
+<!-- Lines like this one are comments and will not be shown in the final output. -->
+<!-- Make sure that you have read the "Contributing" section of the README and also the notes in CodingStyle. -->
+<!-- If you are a collaborator, please add labels and assign other collaborators for a review. -->
+
+### Describe the pull request:
+<!-- Replace [ ] with [x] to select options. -->
+- [ ] Bug fix
+- [ ] Functional change
+- [ ] New feature
+- [ ] Code cleanup
+- [ ] Build system change
+- [ ] Documentation change
+- [ ] Language translation
+
+### Pull request long description:
+<!-- Describe your pull request in detail. -->
+
+### Changes made:
+<!-- Enumerate the changes with 1), 2), 3) etc. -->
+<!-- Ensure the test cases are updated if needed. -->
+
+### Related issues:
+<!-- Reference issues with #<issue-num>. -->
+<!-- Write "Fixes #<issue-num>" to notify Github that this PR fixes an issue. -->
+
+### Additional information:
+<!-- Include sample dive log or other relevant information to allow testing the change where feasible. -->
+
+### Release note:
+<!-- Describe if this change needs a release note present in CHANGELOG.md. -->
+<!-- Also, please make sure to add the release note on top of the file CHANGELOG.md. -->
+
+### Documentation change:
+<!-- If this PR makes changes to user functionality, then the documentation has to be updated too. -->
+<!-- Please, briefly outline here what has changed in terms of the user experience (UX). -->
+<!-- If UX changes have been made, a maintainer should apply the 'needs-documentation-change' label. -->
+
+### Mentions:
+<!-- Mention users that you want to review your pull request with @<user-name>. Leave empty if not sure. -->

.github/workflows/tag_and_build.yaml

@@ -0,0 +1,71 @@
+name: Bump version
+on:
+  push:
+    branches:
+    - master
+jobs:
+  tag:
+    name: bump tags
+    outputs:
+      part: ${{ steps.bump_tag.outputs.part }}
+      tag: ${{ steps.bump_tag.outputs.tag }}
+      new_tag: ${{ steps.bump_tag.outputs.new_tag }}
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: '1'
+    - name: Bump version and push tag
+      id: bump_tag
+      uses: anothrNick/[email protected]
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        WITH_V: true
+        DEFAULT_BUMP: patch
+
+  push_to_registry:
+    needs: tag
+    if: needs.tag.outputs.part != ''
+    name: Push Docker image to Github Container registry
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v2
+
+      - name: Log in to the Github Container registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v1 
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: ghcr.io/${{ github.repository }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: |
+            ghcr.io/${{ github.repository }}:${{ needs.tag.outputs.tag }}
+            ghcr.io/${{ github.repository }}:latest
+            ${{ github.repository }}:${{ needs.tag.outputs.tag }}
+            ${{ github.repository }}:latest
+          labels: |
+            org.opencontainers.image.source=${{ github.event.repository.clone_url }}
+            org.opencontainers.image.created=$(date -u +'%Y-%m-%dT%H:%M:%SZ')
+            org.opencontainers.image.revision=${{ github.sha }}

Dockerfile

@@ -1,20 +1,28 @@
-FROM rabbitmq:3.6.14-management
+FROM rabbitmq:3.8.16-management-alpine
 
-EXPOSE 5672 15672
+ARG BUILD_DATE
+ARG SOURCE_COMMIT
 
-VOLUME /var/lib/rabbitmq
+LABEL maintainer "EGA System Developers"
+LABEL org.label-schema.schema-version="1.0"
+LABEL org.label-schema.build-date=$BUILD_DATE
+LABEL org.label-schema.vcs-url="https://github.com/neicnordic/LocalEGA-mq"
+LABEL org.label-schema.vcs-ref=$SOURCE_COMMIT
 
-RUN mkdir -p /etc/rabbitmq/ && \
-    chown -R rabbitmq:rabbitmq /etc/rabbitmq
+ENV RABBITMQ_CONFIG_FILE=/var/lib/rabbitmq/rabbitmq
+ENV RABBITMQ_ADVANCED_CONFIG_FILE=/var/lib/rabbitmq/advanced
+ENV RABBITMQ_LOG_BASE=/var/lib/rabbitmq
 
-# Initialization
-RUN rabbitmq-plugins enable --offline rabbitmq_federation            && \
-    rabbitmq-plugins enable --offline rabbitmq_federation_management && \
-    rabbitmq-plugins enable --offline rabbitmq_shovel                && \
-    rabbitmq-plugins enable --offline rabbitmq_shovel_management
+RUN apk add --no-cache ca-certificates openssl
 
-COPY entrypoint.sh /usr/local/bin/entrypoint.sh
-RUN chmod 755 /usr/local/bin/entrypoint.sh
+RUN rabbitmq-plugins enable --offline rabbitmq_federation rabbitmq_federation_management rabbitmq_shovel rabbitmq_shovel_management
+
+COPY entrypoint.sh /usr/local/bin/docker-entrypoint.sh
+
+RUN chmod +x /usr/local/bin/docker-entrypoint.sh
+
+USER 100:101
+
+ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]
 
-ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
 CMD ["rabbitmq-server"]

README.md

@@ -1,13 +1,46 @@
-# LocalEGA internal message broker in a docker image
+# NeIC SDA internal message broker in a docker image
 
-We use [RabbitMQ 3.6.14](https://hub.docker.com/_/rabbitmq) including the management plugins.
+We use [RabbitMQ 3.8.16](https://hub.docker.com/_/rabbitmq) including the management plugins.
+
+## Configuration
 
 The following environment variables can be used to configure the broker:
 
 | Variable | Description |
 |---------:|:------------|
+| `MQ_VHOST` | Default vhost other than `/` |
+| `MQ_VERIFY` | Set to `verify_none` to disable verification of client certificate |
 | `MQ_USER` | Default user (with admin rights) |
 | `MQ_PASSWORD_HASH` | Password hash for the above user |
 | `CEGA_CONNECTION` | DSN URL for the shovels and federated queues with CentralEGA |
+| `MQ_SERVER_CERT` | Path to the server SSL certificate |
+| `MQ_SERVER_KEY` | Path to the server SSL key |
+| `MQ_CA` | Path to the CA root certificate |
+| `MQ_VERIFY` | Require client certificates (`verify_peer` or `verify_none`)
+| `NOTLS` | Run the server without SSL |
 
 If you want persistent data, you can use a named volume or a bind-mount and make it point to `/var/lib/rabbitmq`.
+
+## Sample Docker Compose definition
+
+```docker-compose
+version: '3.3'
+
+services:
+
+  mq:
+    image: egarchive/lega-mq:latest
+    hostname: mq
+    ports:
+      - "5672:5672"
+      - "15672:15672"
+    environment:
+      - MQ_VHOST=vhost
+      - MQ_USER=admin
+      - MQ_PASSWORD_HASH=4tHURqDiZzypw0NTvoHhpn8/MMgONWonWxgRZ4NXgR8nZRBz
+      - NOTLS=true
+      - CEGA_CONNECTION
+
+```
+
+Run `docker-compose up -d` to test it.