ALLURE-DOCKER-SERVICE UI

Table of contents

• FEATURES
  • Docker Hub
  • Docker Versions
• USAGE
  • Docker on Unix/Mac
  • Docker on Windows (Git Bash)
  • Docker Compose
  • Implementation Examples
  • Known Issues
  • Accessing UI
  • Extra options
    • Get Info
    • Add Custom URL Prefix
• SUPPORT
  • Gitter
• DOCKER GENERATION (Usage for developers)

FEATURES

Allure Docker Service UI provides a friendly user interface for frankescobar/allure-docker-service API container.

Docker Hub

• Repository: frankescobar/allure-docker-service-ui

Docker Versions

Docker container versions are publish on https://github.com/fescobar/allure-docker-service-ui/releases

Image Variants

Allure Docker Service supports architectures amd64, arm/v7 and arm64.

• Tags: https://hub.docker.com/r/frankescobar/allure-docker-service-ui/tags

USAGE

Docker on Unix/Mac

docker run -p 5050:5050 -e CHECK_RESULTS_EVERY_SECONDS=NONE -e KEEP_HISTORY=1 \
           -v ${PWD}/projects:/app/projects \
           frankescobar/allure-docker-service

docker run -p 5252:5252 -e ALLURE_DOCKER_PUBLIC_API_URL=http://localhost:5050 \
           frankescobar/allure-docker-service-ui

Docker on Windows (Git Bash)

docker run -p 5050:5050 -e CHECK_RESULTS_EVERY_SECONDS=NONE -e KEEP_HISTORY=1 \
           -v "/$(pwd)/projects:/app/projects" \
           frankescobar/allure-docker-service

docker run -p 5252:5252 -e ALLURE_DOCKER_PUBLIC_API_URL=http://localhost:5050 \
           frankescobar/allure-docker-service-ui

Docker Compose

Using docker-compose is the best way to manage containers: allure-docker-multi-project-example/docker-compose.yml

version: '3'
services:
  allure:
    image: "frankescobar/allure-docker-service"
    environment:
      CHECK_RESULTS_EVERY_SECONDS: NONE
      KEEP_HISTORY: 1
      KEEP_HISTORY_LATEST: 25
    ports:
      - "5050:5050"
    volumes:
      - ${PWD}/projects:/app/projects

  allure-ui:
    image: "frankescobar/allure-docker-service-ui"
    environment:
      ALLURE_DOCKER_PUBLIC_API_URL: "http://localhost:5050"
      ALLURE_DOCKER_PUBLIC_API_URL_PREFIX: ""
    ports:
      - "5252:5252"

docker-compose up allure allure-ui

If you want to run in background:

docker-compose up -d allure allure-ui

You can see the logs:

docker-compose logs -f allure
docker-compose logs -f allure-ui

Implementation Examples

Check examples here: frankescobar/allure-docker-service-examples

Known Issues

• Network Error when I tried to access http://localhost:5252/allure-docker-service-ui/ --> https://github.com/fescobar/allure-docker-service-ui/issues/4

Accessing UI

Open your browser and access to the UI: http://localhost:5252/allure-docker-service-ui

Extra options

Get Info

You can get extra info using the next urls:

• http://localhost:5252/allure-docker-service-ui/config

• http://localhost:5252/allure-docker-service-ui/version

Add Custom URL Prefix

Configure an url prefix if your deployment requires it (e.g. reverse proxy with nginx)

    environment:
      URL_PREFIX: "/my-prefix"

With this configuration you can request the UI in this way too:

curl http://localhost:5252/my-prefix/allure-docker-service-ui

SUPPORT

Gitter

DOCKER GENERATION (Usage for developers)

Install Docker

sudo apt-get update

sudo apt install -y docker.io

If you want to use docker without sudo, read following links:

• https://docs.docker.com/engine/installation/linux/linux-postinstall/#manage-docker-as-a-non-root-user
• https://stackoverflow.com/questions/21871479/docker-cant-connect-to-docker-daemon

Build image

docker build -t allure-ui-release -f docker/Dockerfile --build-arg VERSION=na --build-arg VCS_REF=na --build-arg BUILD_DATE=na .

Run container

docker run -d  -p 5252:5252 allure-ui-release

See active containers

docker container ls

Access to container

docker exec -it ${CONTAINER_ID} bash

Access to logs

docker exec -it ${CONTAINER_ID} tail -f log

Remove all containers

docker container rm $(docker container ls -a -q) -f

Remove all images

docker image rm $(docker image ls -a -q)

Remove all stopped containers

docker ps -q -f status=exited | xargs docker rm

Remove all dangling images

docker images -f dangling=true | xargs docker rmi

Register tagged image (Example)

docker login
docker tag allure-ui-release frankescobar/allure-docker-service-ui:${PUBLIC_TAG}
docker push frankescobar/allure-docker-service-ui

Register latest image (Example)

docker tag allure-ui-release frankescobar/allure-docker-service-ui:latest
docker push frankescobar/allure-docker-service-ui

Download latest image registered (Example)

docker run -d  -p 5252:5252 frankescobar/allure-docker-service-ui

Download specific tagged image registered (Example)

docker run -d -p 5252:5252 frankescobar/allure-docker-service-ui:7.0.0