Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update docs for co#tegration #301

Merged
merged 4 commits into from
Mar 30, 2022
Merged

Update docs for co#tegration #301

merged 4 commits into from
Mar 30, 2022

Conversation

a-mccarthy
Copy link
Collaborator

Signed-off-by: Abigail McCarthy mabigail@vmware.com

Signed-off-by: Abigail McCarthy <mabigail@vmware.com>
@a-mccarthy a-mccarthy requested a review from wy65701436 March 17, 2022 02:22
@a-mccarthy a-mccarthy marked this pull request as draft March 17, 2022 02:22
@a-mccarthy
Copy link
Collaborator Author

Setting this as draft because I still need to add screenshots.

@wy65701436 Can you review if you have some time?

I also had a few questions:

  • For replication, will cosign signatures only be replicated when replicating between Harbor instances? Wanted to confirm from the proposal

  • Can you have both the Notary and Cosign deployment security policy enabled? If you have both enabled, how does that work on artifacts? would they need to be signed by both?

  • Notary and Cosign deployment policies are per-project. There is no system level policy, right?


[SCREENSHOT OF ARTIFACT EXPANDED & ACCESSORY TABLE]

### Delete Cosign signatures
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can also add comments that Harbor doesn't support cosign clean to remove signature since it has to implement tag delete API which is not required by OCI distribution spec.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is the tag delete API a part of cosign, or sigstore? just want to make sure i understand how its connected :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what I mean, https://github.com/opencontainers/distribution-spec/blob/main/spec.md#content-management

Harbor doesn't choose to imple tag deletion, but cosign clean is using it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the docs to include this information

@wy65701436
Copy link
Contributor

wy65701436 commented Mar 21, 2022

Thanks @a-mccarthy, should we also consider to add the following?

  1. We should mention that replication between Harbor instances.
  2. As for the deletaion, all the signatures are associated with the subject manifest, once the subject manifest is removed, all the signatures are removed as well.
  3. GC will not remove any signature individually. In other worlds, given the signature is an OCI artifact, but from the perspective of GC, it only can see the standard artifact -- the standalong artifact no matter with or without accessories.

For example, if user chooses to GC untagged artifact, and given any signature has no tag, GC will also not remove it.

  1. Copy Artifact opertaion supports copy signtuare.
  2. Signature does not support scanning.

@wy65701436
Copy link
Contributor

wy65701436 commented Mar 21, 2022

Setting this as draft because I still need to add screenshots.

@wy65701436 Can you review if you have some time?

I also had a few questions:

* For replication, will cosign signatures only be replicated when replicating between Harbor instances? Wanted to confirm from the [proposal](https://github.com/goharbor/community/blob/3894bd7d858fdccbc163619d0f0fda74c302c9ce/proposals/new/cosign-integration.md#replication)

* Can you have both the Notary and Cosign deployment security policy enabled? If you have both enabled, how does that work on artifacts? would they need to be signed by both?

* Notary and Cosign deployment policies are per-project. There is no system level policy, right?
  • As for the replication, singuare will be replicated to any kind of target endpoint.
  1. Harbor-2-Harbor, the target Harbor will manage the link of signed artifact and its signature, user will see the relation in UI like it does in source.
  2. Harbor-2-Others, the target will not. So, user will see they are two coordinate artifacts under the same repository.
  • Yes, we can and it needs to be signed by both.

  • Yes, no system level configuration for pull policy.

Signed-off-by: Abigail McCarthy <mabigail@vmware.com>
@a-mccarthy a-mccarthy requested a review from wy65701436 March 22, 2022 04:12
Signed-off-by: Abigail McCarthy <mabigail@vmware.com>
@a-mccarthy a-mccarthy requested a review from OrlinVasilev March 22, 2022 06:02
@a-mccarthy a-mccarthy marked this pull request as ready for review March 22, 2022 06:03
@a-mccarthy a-mccarthy requested a review from wy65701436 March 22, 2022 14:40

Note that Harbor's [garbage collection](../../administration/garbage-collection/) will not remove any signature individually. In Harbor, Cosign signatures are treated like any other OCI artifact, except from the perspective of the garbage collector which can't see accessory artifacts, like Cosign signatures. For example, if you configure garbage collection for untagged artifacts, Harbor's garbage collector will not remove any signatures without a tag. If the signed artifact is untagged, and matches the configured garbage collect rule, it and any associated signatures will be deleted.

HHarbor doesn't support `cosign clean` to remove signatures.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Harbor?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we also add reason for why?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i updated this

Copy link
Contributor

@wy65701436 wy65701436 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Signed-off-by: Abigail McCarthy <mabigail@vmware.com>
Copy link
Member

@OrlinVasilev OrlinVasilev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@a-mccarthy
Copy link
Collaborator Author

Thanks for the reviews @wy65701436 and @OrlinVasilev!

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants