ratify icon indicating copy to clipboard operation
ratify copied to clipboard

Add documentation for local k8s setup

Open akashsinghal opened this issue 1 year ago • 7 comments

What would you like to be added?

We don't have a full e2e document for local k8s cluster setup with a local registry. Our e2e test uses Kind for this but there is not accompanying documentation. We should also support other local k8s orchestrators like Minikube

Anything else you would like to add?

No response

Are you willing to submit PRs to contribute to this feature?

  • [ ] Yes, I am willing to implement it.

akashsinghal avatar Apr 07 '23 00:04 akashsinghal

Do you want a guide for installing a local K8s cluster or just adding this process to E2E test cases?

FeynmanZhou avatar Apr 14 '23 12:04 FeynmanZhou

@FeynmanZhou The motivation for the issue was to see if it's worth to create a guide for setting up local cluster with local registry (auth -enabled) and configure ratify with k8s secrets/docker config in the basic notation sign/verify scenario. Our local e2e-test already does this but there's not guide for this. Do you think there's value for having this? or is this out of scope for ratify?

akashsinghal avatar Apr 14 '23 20:04 akashsinghal

@akashsinghal Yes. It's worth having this doc to help users get started with Ratify on local Kubernetes from scratch. I will work on this doc.

FeynmanZhou avatar May 02 '23 01:05 FeynmanZhou

My preference would be for kind - https://kind.sigs.k8s.io/docs/user/local-registry/

sajayantony avatar May 02 '23 07:05 sajayantony

I have tested Ratify on local minukube and K3s with a local registry but it was blocked by a local registry connection issue mentioned in https://github.com/deislabs/ratify/issues/874.

I changed to use a public registry and wrote a blog post https://ratify.dev/blog/sign-and-verify-image-with-notation-ratify

FeynmanZhou avatar Aug 17 '23 00:08 FeynmanZhou

@luisdlp Would you mind moving this issue to the ratify website repo?

FeynmanZhou avatar Aug 17 '23 00:08 FeynmanZhou

Transfer this issue to website repo for documentation.

yizha1 avatar Sep 12 '23 05:09 yizha1