search

open-quantum-safe / oqs-demos

PARTIALLY SUPPORTED Instructions for enabling the use of quantum-safe cryptography in assorted software using the OQS suite. CONTRIBUTORS WANTED.
https://openquantumsafe.org/
132 stars 74 forks source link

Add QUIC Workflow #295

Closed pi-314159 closed 2 months ago

pi-314159 commented 2 months ago

Add a GitHub Actions workflow that automates the building, testing, and deployment of Docker images with QUIC support.

pi-314159 commented 2 months ago

@baentsch GHCI passed. Please check https://github.com/open-quantum-safe/oqs-demos/actions/runs/10505026939

Also, docker images are available at https://hub.docker.com/r/openquantumsafe/curl-quic

https://hub.docker.com/r/openquantumsafe/nginx-quic

We need to update the descriptions for these images on Docker Hub

baentsch commented 2 months ago

We need to update the descriptions for these images on Docker Hub

Agreed. This is the exact reason why I created USAGE.md files for the other demos: Their text is then verbatim copied to docker hub. The README.md are for people building/wanting to understand build options; USAGE.md for pure users of ready-made images (wanting to understand config/usage options).

baentsch commented 2 months ago

@baentsch GHCI passed. Please check https://github.com/open-quantum-safe/oqs-demos/actions/runs/10505026939

Ah, it was just wrong env variable names. Good.

pi-314159 commented 2 months ago

@baentsch

I'm ready to merge this now if you're okay with it.

Regarding the description: If you have access to Docker Hub, could you update the description with links to the following resources?

nginx README-QUIC.md (includes example configuration, configuration file locations, and executable location) curl README-QUIC.md (includes instructions on how to use curl) These should be clear and sufficient for now.

baentsch commented 2 months ago

@baentsch

I'm ready to merge this now if you're okay with it.

Regarding the description: If you have access to Docker Hub, could you update the description with links to the following resources?

nginx README-QUIC.md (includes example configuration, configuration file locations, and executable location) curl README-QUIC.md (includes instructions on how to use curl) These should be clear and sufficient for now.

Just added those READMEs at docker hub (surprisingly I still have access there... :), but IMO these files are not sufficiently self-explanatory for the "casual user". But we can do it as an experiment to see whether we get questions (and/or any interest at all :)

Alternatively, again tagging @ajbozarth to consider trying these out and providing feedback and/or USAGE-*quic.md files as part of the revitalization activity.

baentsch commented 2 months ago

I still don't understand why CI fails (incl. the new job). Ideas, @pi-314159 ?

pi-314159 commented 2 months ago

I still don't understand why CI fails (incl. the new job). Ideas, @pi-314159 ?

Ha, this PR is from pi-314159/oqs-demos, so it doesn't have access to the Docker credentials. The CI run that was successful came from open-quantum-safe/oqs-demos/tree/pi-20240822-ghci, which is a fork of pi-314159/oqs-demos/tree/20240822-ghci-quic.

The problem will be resolved once I merge this.