From a1c52d914774bb240e061eb03983ba129f59c35b Mon Sep 17 00:00:00 2001 From: Alex Bozarth Date: Thu, 21 Nov 2024 04:22:09 -0600 Subject: [PATCH] Move deprecated demos into deprecated subdirectory (#320) Creates a `deprecated` subdirectory with a simple README and moves the deprecated envoy, epiphany, openlitespeed, and unbound demo directories into the new subdirectory. Fixes #312 Signed-off-by: Alex Bozarth --- README.md | 2 +- deprecated/README.md | 11 +++++++++++ {envoy => deprecated/envoy}/Dockerfile | 0 {envoy => deprecated/envoy}/README.md | 0 {envoy => deprecated/envoy}/USAGE.md | 0 {envoy => deprecated/envoy}/tls/Dockerfile | 0 {envoy => deprecated/envoy}/tls/README.md | 0 {envoy => deprecated/envoy}/tls/certs/gen_cert.sh | 0 {envoy => deprecated/envoy}/tls/docker-compose.yaml | 0 .../envoy}/tls/envoy-https-http.yaml | 0 {envoy => deprecated/envoy}/tls/init.sh | 0 {envoy => deprecated/envoy}/tls/kill.sh | 0 {envoy => deprecated/envoy}/tls/query.sh | 0 {epiphany => deprecated/epiphany}/Dockerfile | 0 {epiphany => deprecated/epiphany}/README.md | 0 {epiphany => deprecated/epiphany}/USAGE.md | 0 {epiphany => deprecated/epiphany}/certlink.sh | 0 .../epiphany}/openssl-client.cnf | 0 {epiphany => deprecated/epiphany}/startepiphany.sh | 0 .../openlitespeed}/Dockerfile-server | 0 .../openlitespeed}/README.md | 0 .../openlitespeed}/USAGE-client.md | 0 .../openlitespeed}/USAGE-server.md | 0 .../openlitespeed}/build.sh.patch | 0 .../openlitespeed}/build_bssl.sh.patch | 0 .../openlitespeed}/httpd_config.conf | 0 .../openlitespeed}/serverstart.sh | 0 {unbound => deprecated/unbound}/Dockerfile-getdns | 0 {unbound => deprecated/unbound}/Dockerfile-unbound | 0 {unbound => deprecated/unbound}/README.md | 0 {unbound => deprecated/unbound}/USAGE-client.md | 0 {unbound => deprecated/unbound}/USAGE-server.md | 0 {unbound => deprecated/unbound}/unbound.sh | 0 .../unbound}/wireshark_screenshot.png | Bin 34 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 deprecated/README.md rename {envoy => deprecated/envoy}/Dockerfile (100%) rename {envoy => deprecated/envoy}/README.md (100%) rename {envoy => deprecated/envoy}/USAGE.md (100%) rename {envoy => deprecated/envoy}/tls/Dockerfile (100%) rename {envoy => deprecated/envoy}/tls/README.md (100%) rename {envoy => deprecated/envoy}/tls/certs/gen_cert.sh (100%) rename {envoy => deprecated/envoy}/tls/docker-compose.yaml (100%) rename {envoy => deprecated/envoy}/tls/envoy-https-http.yaml (100%) rename {envoy => deprecated/envoy}/tls/init.sh (100%) rename {envoy => deprecated/envoy}/tls/kill.sh (100%) rename {envoy => deprecated/envoy}/tls/query.sh (100%) rename {epiphany => deprecated/epiphany}/Dockerfile (100%) rename {epiphany => deprecated/epiphany}/README.md (100%) rename {epiphany => deprecated/epiphany}/USAGE.md (100%) rename {epiphany => deprecated/epiphany}/certlink.sh (100%) rename {epiphany => deprecated/epiphany}/openssl-client.cnf (100%) rename {epiphany => deprecated/epiphany}/startepiphany.sh (100%) rename {openlitespeed => deprecated/openlitespeed}/Dockerfile-server (100%) rename {openlitespeed => deprecated/openlitespeed}/README.md (100%) rename {openlitespeed => deprecated/openlitespeed}/USAGE-client.md (100%) rename {openlitespeed => deprecated/openlitespeed}/USAGE-server.md (100%) rename {openlitespeed => deprecated/openlitespeed}/build.sh.patch (100%) rename {openlitespeed => deprecated/openlitespeed}/build_bssl.sh.patch (100%) rename {openlitespeed => deprecated/openlitespeed}/httpd_config.conf (100%) rename {openlitespeed => deprecated/openlitespeed}/serverstart.sh (100%) rename {unbound => deprecated/unbound}/Dockerfile-getdns (100%) rename {unbound => deprecated/unbound}/Dockerfile-unbound (100%) rename {unbound => deprecated/unbound}/README.md (100%) rename {unbound => deprecated/unbound}/USAGE-client.md (100%) rename {unbound => deprecated/unbound}/USAGE-server.md (100%) rename {unbound => deprecated/unbound}/unbound.sh (100%) rename {unbound => deprecated/unbound}/wireshark_screenshot.png (100%) diff --git a/README.md b/README.md index bdf46a18..b094c48a 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ In most cases, Dockerfiles encode the instructions for ease-of-use: Just do `doc As the level of interest in providing and maintaining these integrations for public consumption has fallen, the packages are tagged with the github monikers of the persons willing to keep supporting them or the term "Unmaintained". If that tag is listed, no CI and github support for the integration is available and the code shall be seen as a snapshot that once worked only. -We are explicitly soliciting contributors to maintain those integrations labelled "unsupported". +We are explicitly soliciting contributors to maintain those integrations labelled "Unmaintained". Currently available integrations at their respective support level: diff --git a/deprecated/README.md b/deprecated/README.md new file mode 100644 index 00000000..7d7706e0 --- /dev/null +++ b/deprecated/README.md @@ -0,0 +1,11 @@ +# Deprecated demos + +> [!Warning] +> Demos in this directory are longer supported, if you're interested in revitalizing a demo please submit a PR. + +Demos are considered deprecated when two factors are met, and can be un-deprecated by anyone willing to address them: + +1. **Out of date or broken**: Either the demo is still based on the old oqs openssl1.1.1 fork rather than openssl3 using the oqs provider or it is not in a working state. +2. **No interest or expertise**: The community has shown no interest in updating or maintaining the demo + +> **Note**: Demos that only meet factor 2 are considered Unmaintained, not Deprecated. diff --git a/envoy/Dockerfile b/deprecated/envoy/Dockerfile similarity index 100% rename from envoy/Dockerfile rename to deprecated/envoy/Dockerfile diff --git a/envoy/README.md b/deprecated/envoy/README.md similarity index 100% rename from envoy/README.md rename to deprecated/envoy/README.md diff --git a/envoy/USAGE.md b/deprecated/envoy/USAGE.md similarity index 100% rename from envoy/USAGE.md rename to deprecated/envoy/USAGE.md diff --git a/envoy/tls/Dockerfile b/deprecated/envoy/tls/Dockerfile similarity index 100% rename from envoy/tls/Dockerfile rename to deprecated/envoy/tls/Dockerfile diff --git a/envoy/tls/README.md b/deprecated/envoy/tls/README.md similarity index 100% rename from envoy/tls/README.md rename to deprecated/envoy/tls/README.md diff --git a/envoy/tls/certs/gen_cert.sh b/deprecated/envoy/tls/certs/gen_cert.sh similarity index 100% rename from envoy/tls/certs/gen_cert.sh rename to deprecated/envoy/tls/certs/gen_cert.sh diff --git a/envoy/tls/docker-compose.yaml b/deprecated/envoy/tls/docker-compose.yaml similarity index 100% rename from envoy/tls/docker-compose.yaml rename to deprecated/envoy/tls/docker-compose.yaml diff --git a/envoy/tls/envoy-https-http.yaml b/deprecated/envoy/tls/envoy-https-http.yaml similarity index 100% rename from envoy/tls/envoy-https-http.yaml rename to deprecated/envoy/tls/envoy-https-http.yaml diff --git a/envoy/tls/init.sh b/deprecated/envoy/tls/init.sh similarity index 100% rename from envoy/tls/init.sh rename to deprecated/envoy/tls/init.sh diff --git a/envoy/tls/kill.sh b/deprecated/envoy/tls/kill.sh similarity index 100% rename from envoy/tls/kill.sh rename to deprecated/envoy/tls/kill.sh diff --git a/envoy/tls/query.sh b/deprecated/envoy/tls/query.sh similarity index 100% rename from envoy/tls/query.sh rename to deprecated/envoy/tls/query.sh diff --git a/epiphany/Dockerfile b/deprecated/epiphany/Dockerfile similarity index 100% rename from epiphany/Dockerfile rename to deprecated/epiphany/Dockerfile diff --git a/epiphany/README.md b/deprecated/epiphany/README.md similarity index 100% rename from epiphany/README.md rename to deprecated/epiphany/README.md diff --git a/epiphany/USAGE.md b/deprecated/epiphany/USAGE.md similarity index 100% rename from epiphany/USAGE.md rename to deprecated/epiphany/USAGE.md diff --git a/epiphany/certlink.sh b/deprecated/epiphany/certlink.sh similarity index 100% rename from epiphany/certlink.sh rename to deprecated/epiphany/certlink.sh diff --git a/epiphany/openssl-client.cnf b/deprecated/epiphany/openssl-client.cnf similarity index 100% rename from epiphany/openssl-client.cnf rename to deprecated/epiphany/openssl-client.cnf diff --git a/epiphany/startepiphany.sh b/deprecated/epiphany/startepiphany.sh similarity index 100% rename from epiphany/startepiphany.sh rename to deprecated/epiphany/startepiphany.sh diff --git a/openlitespeed/Dockerfile-server b/deprecated/openlitespeed/Dockerfile-server similarity index 100% rename from openlitespeed/Dockerfile-server rename to deprecated/openlitespeed/Dockerfile-server diff --git a/openlitespeed/README.md b/deprecated/openlitespeed/README.md similarity index 100% rename from openlitespeed/README.md rename to deprecated/openlitespeed/README.md diff --git a/openlitespeed/USAGE-client.md b/deprecated/openlitespeed/USAGE-client.md similarity index 100% rename from openlitespeed/USAGE-client.md rename to deprecated/openlitespeed/USAGE-client.md diff --git a/openlitespeed/USAGE-server.md b/deprecated/openlitespeed/USAGE-server.md similarity index 100% rename from openlitespeed/USAGE-server.md rename to deprecated/openlitespeed/USAGE-server.md diff --git a/openlitespeed/build.sh.patch b/deprecated/openlitespeed/build.sh.patch similarity index 100% rename from openlitespeed/build.sh.patch rename to deprecated/openlitespeed/build.sh.patch diff --git a/openlitespeed/build_bssl.sh.patch b/deprecated/openlitespeed/build_bssl.sh.patch similarity index 100% rename from openlitespeed/build_bssl.sh.patch rename to deprecated/openlitespeed/build_bssl.sh.patch diff --git a/openlitespeed/httpd_config.conf b/deprecated/openlitespeed/httpd_config.conf similarity index 100% rename from openlitespeed/httpd_config.conf rename to deprecated/openlitespeed/httpd_config.conf diff --git a/openlitespeed/serverstart.sh b/deprecated/openlitespeed/serverstart.sh similarity index 100% rename from openlitespeed/serverstart.sh rename to deprecated/openlitespeed/serverstart.sh diff --git a/unbound/Dockerfile-getdns b/deprecated/unbound/Dockerfile-getdns similarity index 100% rename from unbound/Dockerfile-getdns rename to deprecated/unbound/Dockerfile-getdns diff --git a/unbound/Dockerfile-unbound b/deprecated/unbound/Dockerfile-unbound similarity index 100% rename from unbound/Dockerfile-unbound rename to deprecated/unbound/Dockerfile-unbound diff --git a/unbound/README.md b/deprecated/unbound/README.md similarity index 100% rename from unbound/README.md rename to deprecated/unbound/README.md diff --git a/unbound/USAGE-client.md b/deprecated/unbound/USAGE-client.md similarity index 100% rename from unbound/USAGE-client.md rename to deprecated/unbound/USAGE-client.md diff --git a/unbound/USAGE-server.md b/deprecated/unbound/USAGE-server.md similarity index 100% rename from unbound/USAGE-server.md rename to deprecated/unbound/USAGE-server.md diff --git a/unbound/unbound.sh b/deprecated/unbound/unbound.sh similarity index 100% rename from unbound/unbound.sh rename to deprecated/unbound/unbound.sh diff --git a/unbound/wireshark_screenshot.png b/deprecated/unbound/wireshark_screenshot.png similarity index 100% rename from unbound/wireshark_screenshot.png rename to deprecated/unbound/wireshark_screenshot.png