Cleanup continued..

- Move Dockerfile to root directory
- Move docker/ctr documentation into doc
- Move docker/ctr examples into examples
- Move docker/ctr release/tools into tools

.github/workflows/ci.yml

@@ -4,12 +4,12 @@ on:
  push:
  paths-ignore:
  - '*.md'
- - 'docker-k8s/**'
+ - 'examples/**'
  - 'Formula/**'
  pull_request:
  paths-ignore:
  - '*.md'
- - 'docker-k8s/**'
+ - 'examples/**'
  - 'Formula/**'
 
 jobs:

.github/workflows/container-build-publish.yml

@@ -6,7 +6,7 @@ on:
  - master
  paths-ignore:
  - 'doc/**'
- - 'docker-k8s/examples/**'
+ - 'examples/**'
  - 'Formula/**'
  - 'tools/get-version'
  - 'windows/**'
@@ -16,7 +16,7 @@ on:
  pull_request:
  paths-ignore:
  - 'doc/**'
- - 'docker-k8s/examples/**'
+ - 'examples/**'
  - 'Formula/**'
  - 'tools/get-version'
  - 'windows/**'
@@ -26,7 +26,7 @@ env:
  REGISTRY: ghcr.io
  IMAGE_NAME: ${{ github.repository }}
  DOCKERHUB_REPO: eturnal/eturnal
- PKGREL_FILE: docker-k8s/pkgrel
+ PKGREL_FILE: tools/ctrrel
 
 jobs:
 ################################################################################

.github/workflows/macos.yml

@@ -5,13 +5,11 @@ on:
  paths-ignore:
  - '*.md'
  - 'doc/**'
- - 'docker-k8s/**'
  - 'windows/**'
  pull_request:
  paths-ignore:
  - '*.md'
  - 'doc/**'
- - 'docker-k8s/**'
  - 'windows/**'
 
 jobs:

.github/workflows/update-dockerhub-readme.yml

@@ -3,10 +3,10 @@ name: Update DockerHub README
 on:
  push:
  paths:
- - docker-k8s/README.md
+ - doc/CONTAINER.md
  - .github/workflows/update-dockerhub-readme.yml
 env:
- README: docker-k8s/README.md
+ README: doc/CONTAINER.md
  DOCKERHUB_REPO: eturnal/eturnal
 
 jobs:

README.md

@@ -100,7 +100,7 @@ As an alternative, there's an `#eturnal` channel [on Slack][23].
  [2]: https://eturnal.net/
  [3]: https://tools.ietf.org/html/draft-uberti-behave-turn-rest-00
  [4]: https://github.com/processone/eturnal/blob/master/doc/QUICK-TEST.md
- [5]: https://github.com/processone/eturnal/blob/master/docker-k8s/QUICK-TEST.md
+ [5]: https://github.com/processone/eturnal/blob/master/doc/CTR-QUICK-TEST.md
  [6]: https://eturnal.net/documentation/code/docker.html
  [7]: https://software.opensuse.org/download/?package=eturnal&project=devel:languages:erlang
  [8]: https://pkgs.alpinelinux.org/packages?name=eturnal

config/doc.config

@@ -8,7 +8,7 @@
 {skip_undefined_reference_warnings_on, [<<"eturnal_module">>]}.
 {extra_section, <<"DOCUMENTATION">>}.
 {extras, [{'README.md', #{title => <<"Overview">>}},
- {'docker-k8s/README.md', #{title => <<"Docker Usage">>,
+ {'doc/CONTAINER.md', #{title => <<"Docker Usage">>,
  filename => "docker"}},
  {'CHANGELOG.md', #{title => <<"Changelog">>}},
  {'LICENSE', #{title => <<"License">>}}]}.

docker-k8s/README.md → doc/CONTAINER.md

@@ -167,9 +167,9 @@ podman unshare chmod 640 /path/to/eturnal.yml
 
 This repository also contains configuration examples for:
 
-* [Docker Compose](https://github.com/processone/eturnal/tree/master/docker-k8s/examples/docker-compose)
-* [Kubernetes (Kustomize)](https://github.com/processone/eturnal/tree/master/docker-k8s/examples/kubernetes-kustomize)
+* [Docker Compose](https://github.com/processone/eturnal/tree/master/examples/docker-compose)
+* [Kubernetes (Kustomize)](https://github.com/processone/eturnal/tree/master/examples/kubernetes-kustomize)
 
 ## Building the images yourself
 
-Instructions can be found [here](https://github.com/processone/eturnal/tree/master/docker-k8s/image).
+Instructions can be found [here](https://github.com/processone/eturnal/tree/master/doc/CTR-BUILD.md).

docker-k8s/image/README.md → doc/CTR-BUILD.md

@@ -4,9 +4,10 @@ Please have a look through the following information to build eturnal images.
 
 ## Dockerfile multi-stage diagram
 
-The `Dockerfile` is a multi-stage Dockerfile. The nodes in the flowchart below
-illustrate the different stages. Thick links between the nodes describe the
-default build process defined by the build arguments in the `Dockerfile`.
+The [Dockerfile](../Dockerfile) is a multi-stage Dockerfile. The nodes in the
+flowchart below illustrate the different stages. Thick links between the nodes
+describe the default build process defined by the build arguments in the
+`Dockerfile`.
 
 ```mermaid
  flowchart LR
@@ -35,7 +36,7 @@ From the root of the repository, to build with `local` source files the
 
 ```shell
 docker buildx build --load \
- -f docker-k8s/image/Dockerfile \
+ -f Dockerfile \
  -t myname/eturnal:mytag \
  --build-arg METHOD='build' \
  --build-arg SOURCE='local' \
@@ -51,7 +52,7 @@ be:
 
 ```shell
 docker buildx build --load \
- -f docker-k8s/image/Dockerfile \
+ -f Dockerfile \
  -t myname/eturnal:mytag \
  --build-arg METHOD='build' \
  --build-arg SOURCE='git' \
@@ -66,7 +67,7 @@ the [official archive](https://eturnal.net/download/).
 
 ```shell
 docker buildx build --load \
- -f docker-k8s/image/Dockerfile \
+ -f Dockerfile \
  -t myname/eturnal:mytag \
  --build-arg METHOD='build' \
  --build-arg SOURCE='web' \
@@ -75,14 +76,14 @@ docker buildx build --load \
 ```
 
 Building with `METHOD='package'` requires eturnal binary tarballs built with the
-[make-binaries](../../tools/make-binaries) script from this repository. The
+[make-binaries](../tools/make-binaries) script from this repository. The
 respective targets must be `x86_64-linux-musl` or `aarch64-linux-musl`. This
 depends of course on the image variant you want to build. The tarballs must be
 located in the root of the repository.
 
 ```shell
 docker buildx build --load \
- -f docker-k8s/image/Dockerfile \
+ -f Dockerfile \
  -t myname/eturnal:mytag \
  --build-arg METHOD='package' \
  .
@@ -97,7 +98,7 @@ From the root of the eturnal repository, do:
 
 ```shell
 docker build \
- -f docker-k8s/image/Dockerfile.ctng \
+ -f tools/Dockerfile.ctng \
  -t localhost/myname/ctng:eturnal \
  .
 ```

tools/make-containers

@@ -104,7 +104,7 @@ registries='docker.io'
 repo_name='eturnal/eturnal'
 dockerfile="$(find -name Dockerfile)"
 install="${METHOD:-build}"
-readme='docker-k8s/README.md'
+readme='doc/CONTAINER.md'
 
 if [ "$install" = 'package' ]
 then

tools/make-release

@@ -60,10 +60,10 @@ fi
 
 echo "$myself: Editing repository files ..."
 sed -i -e "s|^rel_vsn=.*|rel_vsn='$new_vsn'|" 'tools/get-version'
-sed -i -e "s|^$old_vsn-r.*|$new_vsn-r0|" 'docker-k8s/pkgrel'
+sed -i -e "s|^$old_vsn-r.*|$new_vsn-r0|" 'tools/ctrrel'
 sed -i -e "s|$(echo "$old_vsn" | sed 's/\./\\./g')|$new_vsn|g" \
  'README.md' 'doc/INSTALL.md' 'doc/QUICK-TEST.md' 'doc/overview.edoc' \
- 'docker-k8s/README.md'
+ 'doc/CONTAINER.md'
 sed -i -e "s|^rebar_vsn=.*|rebar_vsn='$rebar_vsn'|" \
  'tools/make-source' 'tools/make-binaries'
 sed -i -e "s|compare/$old_vsn|compare/$new_vsn|" \
@@ -75,8 +75,8 @@ sed -i -e "s|compare/$old_vsn|compare/$new_vsn|" \
 
 echo "$myself: Committing result ..."
 git add 'rebar.config' 'CHANGELOG.md' 'README.md' 'doc/INSTALL.md' \
- 'doc/QUICK-TEST.md' 'doc/overview.edoc' 'docker-k8s/README.md' \
- 'docker-k8s/pkgrel' 'tools/get-version' 'tools/make-source' \
+ 'doc/QUICK-TEST.md' 'doc/overview.edoc' 'doc/CONTAINER.md' \
+ 'tools/ctrrel' 'tools/get-version' 'tools/make-source' \
  'tools/make-binaries'
 git commit -m "Release $new_vsn"
 git -P show