Cri-o: missing documentation for policy.json

Created on 13 Sep 2017  Â·  10Comments  Â·  Source: cri-o/cri-o

There is no proper documentation, which explains how to create default policy.json which is mandatory for crioctl image pull command.

About policy.json

  • After looking into code, I was able to figure out, policy.json could be taken from image/signature.
  • The example policy seems rejecting all images by default.
  • It will be helpful, to provide default policy, which can be used to download images from public registries

Most helpful comment

I was able to figure it out from test/policy.json. Though adding in README or tutorial will help.

All 10 comments

The default policy in skopeo (which uses containers/image) is what you need to use and what we use as well. https://github.com/projectatomic/skopeo/blob/master/default-policy.json

We need to add documentation around policy.json though. I'll write a blog and enhance the Readme as well.

I was able to figure it out from test/policy.json. Though adding in README or tutorial will help.

Does json support comments? Can we add comments to our policy.json to tell people how to use it?

It does not unfortunately. Let's enhance the readme and documentation (even
crio(8)). I'm also writing a blog post which explains policy.json and
sigstores.

2017-09-13 15:10 GMT+02:00 Daniel J Walsh notifications@github.com:

Does json support comments? Can we add comments to our policy.json to tell
people how to use it?

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
https://github.com/kubernetes-incubator/cri-o/issues/901#issuecomment-329162767,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAz3-wPiAV402hrnSUJr0jIdDq4B2pFmks5sh9RfgaJpZM4PVfNF
.

--
Antonio Murdaca

Do we have better documentation and can we close this issue?

There are upstream docs here. We got more docs on files consumed by crio in #1476, but docs for this file were not among them. Upstream doesn't seem to provide a man page for policy.json, but perhaps we can just link here from our man page? Would we want to pin that link to whatever version of containers/image we were currently vendoring or let it float with upstream's master?

https://github.com/containers/image/pull/435
I am rebuilding skopeo-containers to provide this man page.

Closed by #1497.

Looks like this was fixed, @rhatdan @mrunalp please close.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

kubealex picture kubealex  Â·  9Comments

sameo picture sameo  Â·  7Comments

cyphar picture cyphar  Â·  7Comments

saschagrunert picture saschagrunert  Â·  8Comments

hswong3i picture hswong3i  Â·  3Comments