Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add QUIC Workflow #295

Merged
merged 6 commits into from
Aug 23, 2024
Merged

Conversation

pi-314159
Copy link
Member

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

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

Signed-off-by: pi-314159 <[email protected]>
Copy link
Member

@baentsch baentsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks very much for this CI -- it brings this demo to what I consider the "perfect" usage state (ready-made dockerimage) -- however, it fails to run as it doesn't have access to the OQS docker hub privileges. This is caused IMO by the code being based in your private fork, @pi-314159 . So, can I ask you move this to open-quantum-safe/oqs-demos instead (branch prefixed "pi-", so we know who did it)? You have all required permissions now and CI should then run OK. Please also check the single question above.

@pi-314159
Copy link
Member Author

@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
Copy link
Member

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
Copy link
Member

@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
Copy link
Member Author

@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
Copy link
Member

@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
Copy link
Member

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

@pi-314159
Copy link
Member Author

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.

Signed-off-by: pi-314159 <[email protected]>
update nginx to 1.26.2

Signed-off-by: PI <[email protected]>
@pi-314159 pi-314159 merged commit 69a5e36 into open-quantum-safe:main Aug 23, 2024
1 of 5 checks passed
@pi-314159 pi-314159 deleted the 20240822-ghci-quic branch August 23, 2024 07:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants