search

w3c / automotive-viss2

MIT License
9 stars 15 forks source link

Docker instructions insufficient for succesful deployment - believe this applies to non-docker as well. Missing Certificate Authority #86

Open slawr opened 11 months ago

slawr commented 11 months ago

Summary

Re-opening the build issue previously raised by Renjith @volvorenjithraj https://github.com/w3c/automotive-viss2/issues/58

Failure occurs at https://github.com/w3c/automotive-viss2/blob/852b779dfd8ff552f8e2b5cc96cac4472ba85fe4/Dockerfile#L37

Docker build fails without a manual step related to certificates that is neither automated or documented in the build instructions as far as I can see. Depending on how it should be handled it appears to be a documentation and or build automation error.

I could also not find documentation for this step in the tutorial or build instructions in the root README so its possible that this also applies to the general non-docker case for newcomers to the project.

Notes

As Renjith mentions a path to a solution is documented in the testCredGen readme, but this is only arrived at by debugging the failure and trying to figure out what is needed to fill the gap, rather than a description of the runtime environment for the server in its setup documentation. At the time of writing its unknown if the testCredGen README has sufficient information to solve the issue.

As an aside this issue would need to be addressed if the project wished to push a WAII image to a Docker image repository.

See #87 for manual workaround: create sub-directory and manually run script

In my case I am consuming WAII in the downstream Covesa project Central Data Service Playground. One goal of the playground is very simple accessibility (ease of setup) so we are interested in finding and fixing these gaps with you.

UlfBj commented 11 months ago

@slawr Is this Ok to close after the PRs on the other issues?

slawr commented 11 months ago

Hi Ulf, I think the build documentation issue (need to run the script before docker build) might remain. Let me check..

slawr commented 10 months ago

Hi Ulf,

PR #90 does appear to address issue #87, i.e. the directory no longer needs to be manually created and the script successfully generates the certs. This was confirmed today during a joint debug session where I was trying to help Arnaldo through WAII build issues on a clean Central Data Service Playground build.

This joint session however confirmed that whilst the script now succeeds the Docker build still fails as the dockerfile only copies the generated certs but does not run the script. That requirement is not mitigated by any build setup instruction in the Docker doc. A developer must figure it out through debugging the build failure.

In the non-Docker case there is nothing I could find in the build instructions in https://github.com/w3c/automotive-viss2/blob/bd92da77ea14c10a5aa30ae20735ff29886d16f3/README.md?plain=1#L14 or https://w3c.github.io/automotive-viss2/build-system/ that is required. If it isn't required for a standard build of the non-Docker source then of course that is fine, but I mention it here in case it also needs to be addressed.