cf51c7ed9f
When doing a podman images, manifests lists look just like images, so it is logical that users would assume that they can just podman push them to a registry. The problem is we throw out weird errors when this happens and users need to somehow figure out this is a manifest list rather then an image, and frankly the user will not understand the difference. This PR will make podman push just do the right thing, by failing over and attempting to push the manifest if it fails to push the image. Fix up handling of manifest push Protocol should bring back a digest string, which can either be printed or stored in a file. We should not reimplement the manifest push setup code in the tunnel code but take advantage of the api path, to make sure remote and local work the same way. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> |
||
---|---|---|
.. | ||
source | ||
tutorials | ||
dckrman.sh | ||
links-to-html.lua | ||
make.bat | ||
Makefile | ||
play.png | ||
podman-derivative-api | ||
Readme.md | ||
remote-docs.sh | ||
requirements.txt |
Podman Documentation
The online man pages and other documents regarding Podman can be found at Read The Docs. The man pages can be found under the Commands link on that page.
Build the Docs
Directory Structure
Directory | |
---|---|
Markdown source for man pages | docs/source/markdown/ |
man pages aliases as .so files | docs/source/markdown/links/ |
restructured text for readthedocs.io | docs/rst/ |
target for output | docs/build |
man pages | docs/build/man |
remote linux man pages | docs/build/remote/linux |
remote darwin man pages | docs/build/remote/darwin |
remote windows html pages | docs/build/remote/windows |
Support files
docs/remote-docs.sh | Read the docs/source/markdown files and format for each platform |
docs/links-to-html.lua | pandoc filter to do aliases for html files |
API Reference
The latest online documentation is
automatically generated by two cooperating automation systems based on committed upstream
source code. Firstly, the Cirrus-CI docs task builds
pkg/api/swagger.yaml
and uploads it to a public-facing location (Google Storage Bucket -
an online service for storing unstructured data). Second, Read The Docs
reacts to the github.com repository change, building the content for the libpod documentation
site. This site includes for the API section,
some javascript which consumes the uploaded swagger.yaml
file directly from the Google
Storage Bucket.
Since there are multiple systems and local cache is involved, it's possible that updates to documentation (especially the swagger/API docs) will lag by 10-or-so minutes. However, because the client (i.e. your web browser) is fetching content from multiple locations that do not share a common domain, accessing the API section may show a stack-trace similar to the following:
If reloading the page, or clearing your local cache does not fix the problem, it is
likely caused by broken metadata needed to protect clients from cross-site-scripting
style attacks. Please notify a maintainer
so they may investigate how/why the swagger.yaml
file's CORS-metadata is
incorrect, or the file isn't accessible for some other reason.