Add docs showing how to validate images are loaded #132
Conversation
docs/validation.md
Outdated
| ``` | ||
|
|
||
| ## Build a simple image | ||
| This image just emits a single line of text output and exits with success - suitable to run as a Job. |
There was a problem hiding this comment.
Maybe:
We'll first build a simple image which prints "Success!" after it runs. We won't tag this with latest since that would cause Kubernetes to try to pull it from a registry.
|
|
||
| ## Troubleshooting | ||
| ``` | ||
| kubectl logs -l job-name=testjob1 |
There was a problem hiding this comment.
What would you look for in the logs here?
| kubectl describe pod -l job-name=testjob1 | ||
| ``` | ||
|
|
||
| If the images are not getting loaded properly into the container runtime, you'll see an Event that looks like this: |
There was a problem hiding this comment.
This was a little confusing because there are the two commands above. I'm not sure if the warning will also show up in the logs, or only when you describe the job.
| Warning ErrImageNeverPull 4s (x11 over 99s) kubelet Container image "acme.com/some/image:1.0" is not present with pull policy of Never | ||
| ``` | ||
|
|
||
| In that case, take a closer look at the output from the build command and/or get logs for the builder pod(s) |
There was a problem hiding this comment.
How would you fix it if this was the case? Are there any specific failures that the user should be looking out for?
There was a problem hiding this comment.
I don't have a good set of common/known failure modes, but I expanded this section a bit with some more guidance.
This short doc will help users quickly test if their configuration is working properly, and images are getting loaded into the container runtime.
Codecov Report
@@ Coverage Diff @@
## main #132 +/- ##
==========================================
- Coverage 65.13% 62.37% -2.77%
==========================================
Files 40 40
Lines 2825 2825
==========================================
- Hits 1840 1762 -78
- Misses 761 848 +87
+ Partials 224 215 -9
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
dhiltgen
force-pushed
the
validation_docs
branch
6 times, most recently
from
eec2e95 to
b50fb55
Compare
This short doc will help users quickly test if their configuration
is working properly, and images are getting loaded into the
container runtime.