Skip to content

Commit

Permalink
Update repository name
Browse files Browse the repository at this point in the history
  • Loading branch information
malaskowski committed Aug 24, 2021
1 parent 9ccdf0c commit cc66508
Show file tree
Hide file tree
Showing 12 changed files with 50 additions and 54 deletions.
13 changes: 0 additions & 13 deletions .github/workflows/greetings.yml

This file was deleted.

9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Not released yet
Nothing new...

# 1.0.0
### Images moved to my new Docker Hub space: https://hub.docker.com/u/malaskowski
This means you need to update both image name and tag in you AET instance cluster to be able to fetch the latest version of AET Docker images (rename `skejven/aet_XXX:0.14.0` to `malaskowski/aet_XXX:1.0.0`).

- [PR-28](https://github.com/Skejven/aet-docker/pull/28) - Before the start of a Karaf service, Docker secrets are exported to environment variables.
- Base images updates:
- `aet_client` image base updated to `alpine:3.14`
- `aet_report` image base updated to `httpd:2.4.48-alpine`

# 0.14.0
- [PR-27](https://github.com/Skejven/aet-docker/pull/27) - Karaf provisioned with all dependencies - offline mode provisioning support.
Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# AET Docker
<p align="center">
<img src="https://raw.githubusercontent.com/Skejven/aet-docker/master/misc/aet-docker.png" alt="AET Docker Logo"/>
<img src="https://raw.githubusercontent.com/malaskowski/aet-docker/master/misc/aet-docker.png" alt="AET Docker Logo"/>
</p>

This repository contains Dockerfiles of AET images and example Docker Swarm manifest that enables setting up simple AET instance.
You may find released versions of AET Docker images at [Docker Hub](https://cloud.docker.com/u/skejven/).
You may find released versions of AET Docker images at [Docker Hub](https://cloud.docker.com/u/malaskowski/).
## Try AET
Following section describes how to run AET using Docker Swarm. Alternative to this is installing AET using Helm. See [AET Helm chart](https://github.com/malaskowski/aet-helm) repository for more deails.

### Run local instance using Docker Swarm
Make sure you have running Docker Swarm instance that has at least **`4 vCPU` and `8 GB of memory` available**. Read more in [Prerequisites](#prerequisites).

Follow these instructions to set up local AET instance:
1. Download the latest [`example-aet-swarm.zip`](https://github.com/Skejven/aet-docker/releases/latest/download/example-aet-swarm.zip) and unzip the files to the folder from where docker stack will be deployed (from now on we will call it `AET_ROOT`).
1. Download the latest [`example-aet-swarm.zip`](https://github.com/malaskowski/aet-docker/releases/latest/download/example-aet-swarm.zip) and unzip the files to the folder from where docker stack will be deployed (from now on we will call it `AET_ROOT`).

<details><summary>See details</summary>
<p>

> You may run following script to automate this step:
> ```bash
> curl -sS `curl -Ls -o /dev/null -w %{url_effective} https://github.com/Skejven/aet-docker/releases/latest/download/example-aet-swarm.zip` > aet-swarm.zip \
> curl -sS `curl -Ls -o /dev/null -w %{url_effective} https://github.com/malaskowski/aet-docker/releases/latest/download/example-aet-swarm.zip` > aet-swarm.zip \
> && unzip -q aet-swarm.zip && mv example-aet-swarm/* . \
> && rm -d example-aet-swarm && rm aet-swarm.zip
> ```
Expand Down Expand Up @@ -52,7 +52,7 @@ Follow these instructions to set up local AET instance:
> - /osgi-configs/configs:/aet/configs # when using docker-machine, use mounted folder
> ```
>
> You can find older versions in the [release](https://github.com/Skejven/aet-docker/releases) section.
> You can find older versions in the [release](https://github.com/malaskowski/aet-docker/releases) section.
</p>
</details>
Expand All @@ -77,7 +77,7 @@ Follow these instructions to set up local AET instance:
>
> ```
> IMAGE STATUS
> skejven/aet_karaf:0.14.0 Up 3 minutes (healthy)
> malaskowski/aet_karaf:0.14.0 Up 3 minutes (healthy)
> ```
</p>
Expand All @@ -86,7 +86,7 @@ Follow these instructions to set up local AET instance:
### Run sample suite
Simply run:
```
docker run --rm skejven/aet_client
docker run --rm malaskowski/aet_client
```
You should see similar output:
Expand Down Expand Up @@ -157,7 +157,7 @@ Before the start of a Karaf service, Docker secrets are exported to environment
### AET Report
Runs [Apache Server](https://httpd.apache.org/) that hosts [AET Report](https://github.com/wttech/aet/wiki/SuiteReport).
The [AET report application](https://github.com/wttech/aet/tree/master/report) is placed under `/usr/local/apache2/htdocs`.
Defines very basic `VirtualHost` (see [aet.conf](https://github.com/Skejven/aet-docker/blob/master/report/aet.conf)).
Defines very basic `VirtualHost` (see [aet.conf](https://github.com/malaskowski/aet-docker/blob/master/report/aet.conf)).
### AET Docker Client
[AET bash client](https://github.com/wttech/aet/tree/master/client/client-scripts) embedded into Docker image with all its dependencies (`jq`, `curl`, `xmllint`).
Expand Down Expand Up @@ -272,14 +272,14 @@ There are couple of ways to start AET Suite.
#### Docker Client
You may use an image that embeds AET Bash client together with its dependencies by running:
> `docker run --rm skejven/aet_client`
> `docker run --rm malaskowski/aet_client`
This will run a [sample AET Suite](https://github.com/malaskowski/aet-docker/blob/master/client/example.xml).
You should see the results in less than 30s.
To run your custom suite, let's say `my-suite.xml`, located in the current directory, you need to bind mount it as volume.
> `docker run --rm -v "$(pwd)/my-suite.xml:/aet/suite/my-suite.xml" skejven/aet_client http://host.docker.internal:8181 /aet/suite/my-suite.xml`
> `docker run --rm -v "$(pwd)/my-suite.xml:/aet/suite/my-suite.xml" malaskowski/aet_client http://host.docker.internal:8181 /aet/suite/my-suite.xml`
<details><summary>Read more</summary>
Expand All @@ -294,7 +294,7 @@ To run your custom suite, let's say `my-suite.xml`, located in the current direc
>
> One more thing you may want to do is to preserve `redirect.html` and `xUnit.xml` files after the AET Client container's run ends its execution. Simply bind mound another volume e.g.:
>
> `docker run --rm -v "$(pwd)/my-suite.xml:/aet/suite/my-suite.xml" -v "$(pwd)/report:/aet/report" skejven/aet_client http://host.docker.internal:8181 /aet/suite/my-suite.xml`
> `docker run --rm -v "$(pwd)/my-suite.xml:/aet/suite/my-suite.xml" -v "$(pwd)/report:/aet/report" malaskowski/aet_client http://host.docker.internal:8181 /aet/suite/my-suite.xml`
>
> The results will be saved to the `report` directory:
>
Expand Down Expand Up @@ -425,10 +425,10 @@ or [OpenShift](https://www.openshift.com/) systems (including services provided
2. Build all images using `build.sh {tag}`.
You should see following images:
```
skejven/aet_report:{tag}
skejven/aet_karaf:{tag}
skejven/aet_browsermob:{tag}
skejven/aet_activemq:{tag}
malaskowski/aet_report:{tag}
malaskowski/aet_karaf:{tag}
malaskowski/aet_browsermob:{tag}
malaskowski/aet_activemq:{tag}
```
## Developer environment
Expand Down
2 changes: 1 addition & 1 deletion activemq/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#

FROM openjdk:8-alpine
LABEL maintainer="Maciej Laskowski <skejven@gmail.com>"
LABEL maintainer="Maciej Laskowski <https://github.com/malaskowski>"

# Set the build params
ARG VERSION=5.15.2
Expand Down
2 changes: 1 addition & 1 deletion browsermob/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#

FROM openjdk:8-alpine
LABEL maintainer="Maciej Laskowski <skejven@gmail.com>"
LABEL maintainer="Maciej Laskowski <https://github.com/malaskowski>"

# Set the build params
ARG BMP_VERSION="2.1.4"
Expand Down
10 changes: 5 additions & 5 deletions build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@

AET_DOCKER_VERSION="$1"

docker build -t skejven/aet_client:${AET_DOCKER_VERSION} client/
docker build -t skejven/aet_activemq:${AET_DOCKER_VERSION} activemq/
docker build -t skejven/aet_browsermob:${AET_DOCKER_VERSION} browsermob/
docker build -t skejven/aet_report:${AET_DOCKER_VERSION} report/
docker build -t skejven/aet_karaf:${AET_DOCKER_VERSION} karaf/
docker build -t malaskowski/aet_client:${AET_DOCKER_VERSION} client/
docker build -t malaskowski/aet_activemq:${AET_DOCKER_VERSION} activemq/
docker build -t malaskowski/aet_browsermob:${AET_DOCKER_VERSION} browsermob/
docker build -t malaskowski/aet_report:${AET_DOCKER_VERSION} report/
docker build -t malaskowski/aet_karaf:${AET_DOCKER_VERSION} karaf/
4 changes: 2 additions & 2 deletions client/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
# limitations under the License.
#

FROM alpine:3.12.0
LABEL maintainer="Maciej Laskowski <skejven@gmail.com>"
FROM alpine:3.14
LABEL maintainer="Maciej Laskowski <https://github.com/malaskowski>"

RUN apk add --no-cache \
bash \
Expand Down
8 changes: 4 additions & 4 deletions example-aet-swarm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ AET stack defined in this example runs:
- `configs` - directory mounted to the `/aet/custom/configs` in the Karaf service, contains OSGi components in form of `.cfg` files
- `features` - directory mounted to the `/aet/custom/features in the Karaf service`, contains [Karaf provisioning](https://karaf.apache.org/manual/latest/provisioning) configuration files - called features
- `report` - directory that may contain custom AET report application, if mounted to `/usr/local/apache2/htdocs` volume in the Report service, it will override default [AET Report application](https://github.com/Cognifide/aet/tree/master/report)
- `secrets` - directory contains example [Docker secret](https://docs.docker.com/engine/swarm/secrets/) files. They are scanned before Karaf starts and exported as environment variables. Read more in the [secrets configuration](https://github.com/Skejven/aet-docker#docker-secrets).
- `secrets` - directory contains example [Docker secret](https://docs.docker.com/engine/swarm/secrets/) files. They are scanned before Karaf starts and exported as environment variables. Read more in the [secrets configuration](https://github.com/malaskowski/aet-docker#docker-secrets).

## Karaf healthcheck
Karaf's service in this sample docker instance have [healthcheck](https://docs.docker.com/compose/compose-file/#healthcheck). It simply checks the dedicated service's endpoint `/health-check` that responses with `200` when everything is ready, with error code otherwise. If the healthcheck fails, swarm will automatically restart the service.
Expand All @@ -43,10 +43,10 @@ Read more about this endpoint here: https://fabric8.io/guide/karaf.html#fabric8-
## AET Extensions

### Lighthouse
You may configure this AET instance to run Lighthouse reports with [AET Lighthouse Extension](https://github.com/Skejven/aet-lighthouse-extension).
You may configure this AET instance to run Lighthouse reports with [AET Lighthouse Extension](https://github.com/malaskowski/aet-lighthouse-extension).
In order to be able to use `<lighthouse/>` extension, you need to provide working Lighthouse Server instance.
Use instructions from the [AET Lighthouse plugin](https://github.com/Skejven/aet-lighthouse-extension/tree/master/lighthouse-server#lighthouse-server-for-aet-collector)
to run server locally. You may find the zipped server [here](https://github.com/Skejven/aet-lighthouse-extension/releases/download/0.1.0/aet-lighthouse-server.zip).
Use instructions from the [AET Lighthouse plugin](https://github.com/malaskowski/aet-lighthouse-extension/tree/master/lighthouse-server#lighthouse-server-for-aet-collector)
to run server locally. You may find the zipped server [here](https://github.com/malaskowski/aet-lighthouse-extension/releases/download/0.1.0/aet-lighthouse-server.zip).

Remember to configure `lighthouseInstanceUri` property in the `configs/com.github.skejven.collector.LighthouseCollectorFactory.cfg`.
(It should work OOTB with AET Lighthouse Server running locally).
Expand Down
8 changes: 4 additions & 4 deletions example-aet-swarm/aet-swarm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,22 +77,22 @@ services:
- private

activemq:
image: skejven/aet_activemq:0.14.0
image: malaskowski/aet_activemq:1.0.0
ports:
- '8161:8161'
networks:
- private

browsermob:
image: skejven/aet_browsermob:0.14.0
image: malaskowski/aet_browsermob:1.0.0
ports:
- '8080:8080'
- '8281-8681:8281-8681'
networks:
- private

karaf:
image: skejven/aet_karaf:0.14.0
image: malaskowski/aet_karaf:1.0.0
healthcheck:
test: curl --fail http://karaf:karaf@localhost:8181/health-check
interval: 1m
Expand All @@ -117,7 +117,7 @@ services:
- private

report:
image: skejven/aet_report:0.14.0
image: malaskowski/aet_report:1.0.0
ports:
- '80:80'
# volumes:
Expand Down
4 changes: 2 additions & 2 deletions karaf/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#

FROM openjdk:8-alpine as build
LABEL maintainer="Maciej Laskowski <skejven@gmail.com>"
LABEL maintainer="Maciej Laskowski <https://github.com/malaskowski>"

# Set the env params
ENV JAVA_MAX_MEM 1024m
Expand Down Expand Up @@ -58,7 +58,7 @@ RUN chmod a+x /tmp/provision-karaf.sh && sync && /tmp/provision-karaf.sh
#################################################################################

FROM openjdk:8-alpine as final
LABEL maintainer="Maciej Laskowski <skejven@gmail.com>"
LABEL maintainer="Maciej Laskowski <https://github.com/malaskowski>"

# Set the env params
ENV KARAF_USER karaf
Expand Down
10 changes: 5 additions & 5 deletions push.sh
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@

AET_DOCKER_VERSION="$1"

docker push skejven/aet_activemq:${AET_DOCKER_VERSION}
docker push skejven/aet_browsermob:${AET_DOCKER_VERSION}
docker push skejven/aet_karaf:${AET_DOCKER_VERSION}
docker push skejven/aet_report:${AET_DOCKER_VERSION}
docker push skejven/aet_client:${AET_DOCKER_VERSION}
docker push malaskowski/aet_activemq:${AET_DOCKER_VERSION}
docker push malaskowski/aet_browsermob:${AET_DOCKER_VERSION}
docker push malaskowski/aet_karaf:${AET_DOCKER_VERSION}
docker push malaskowski/aet_report:${AET_DOCKER_VERSION}
docker push malaskowski/aet_client:${AET_DOCKER_VERSION}
4 changes: 2 additions & 2 deletions report/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
# limitations under the License.
#

FROM httpd:alpine
LABEL maintainers="Jan Helak <https://github.com/heljan>, Maciej Laskowski <skejven@gmail.com>"
FROM httpd:2.4.48-alpine
LABEL maintainers="Jan Helak <https://github.com/heljan>, Maciej Laskowski <https://github.com/malaskowski>"


# set the build params
Expand Down

0 comments on commit cc66508

Please sign in to comment.