oras-project / oras-dotnet Goto Github PK

Reference: https://github.com/oras-project/oras-go/blob/main/content/memory/memory.go

1. Define Content-Addressable Storage (CAS)
2. Define tagging and resolving interfaces
3. Define Target
4. Define Copy

Reference: https://github.com/oras-project/oras-go/blob/main/target.go

Calling FetchReferenceAsync with a tag as a reference, e.g., registryhost.com/myrepository/test:latest, erroneously throws a System.InvalidOperationException: 'The given header was not found.' if the registry server fails to include the Docker-Content-Digest in the response.

Per the OCI Distribution spec (link) this is a legacy header and is optional. Container services, such as AWS's Elastic Container Registry, do not supply this header and thus fail with the .NET version of the Oras library. NOTE: the Go version of this library functions correctly and does not exhibit this error.

The issue stems from an unhandled except in Oras.Remote.ManifestStore.GenerateDescriptor here. The call to GetValues on line 642 will throw an exception of the specified header is cannot be found (reference). Additionally, the call to First in the subsequence line will also throw an exception if serverHeaderDigest is null.

A workaround is to change this call to used TryGetValues instead and check for call prior to calling First, as in the following:

With this change, the code executes in a manner consistent with the Go version of the Oras library.

Tasks:

• Implement Referrers API
• Implement Referrers Tag Schema

References:

• image-spec
• distribution-spec

Reference: https://github.com/oras-project/oras-go/blob/main/registry/repository.go#L26-L54

At least 2 approvals are needed from the 3 maintainers for tagging c2c560c as v0.2.0.

• Samson Amaugo (@sammychinedu2ky)
• Shiwei Zhang (@shizhMSFT)
• Sylvia Lei (@Wwwsylvia)

The changes compared to v0.1.0 include:

• #20
• #21
• #23
• #28
• #29
• #30
• #31
• #32
• #33
• #67
• #68
• #69
• #70
• #71
• #34
• #75
• #76
• #77
• #78
• #79
• #85
• #84
• #86
• #88
• #87
• #89
• #90
• #92
• #93
• #95
• #94
• #97
• #96
• #98
• #99
• #100
• #101
• #102
• #104
• #105

See the full changelog for more details.
Please respond LGTM or REJECT (with reasoning).

Support the Copy function without options.

Reference: https://github.com/oras-project/oras-go/blob/main/copy.go

The registry client should be conforming distribution spec v1.0.1 and Docker V2 API.

API list: https://github.com/opencontainers/distribution-spec/blob/v1.0.0/spec.md#endpoints

Reference: https://github.com/oras-project/oras-go/blob/main/registry/remote/repository.go
Local registry for testing: https://docs.docker.com/registry/

We should add a workflow to automatically generate a local nuget package on release.

Like what we have in the oras-go repository: https://github.com/oras-project/oras-go/blob/main/.github/workflows/build.yml

There should also be a local nuget package

Reference: https://github.com/oras-project/oras-go/blob/main/registry/remote/auth/client.go#L263-L276

We should use docfx to generate documentation and publish to GitHub page.

What is the version of your ORAS CLI

v0.16.0

What would you like to be added?

ORAS has Python and Golang SDK that allow developers to build their own clients on top of one of the libraries. Similarly, developing a .NET SDK will enable .Net developers to use ORAS API and enhance the ORAS ecosystem.

This issue is open for the CNCF LFX Mentorship 2023 program. If you are interested in implementing this issue, please let us know.

Why is this needed for ORAS?

Enable .Net developers to use ORAS API and enhance the ORAS ecosystem.

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

• Yes, I am willing to implement it.

The current API documentation is for the main branch.

It is better to have versioned API documentation and URL links.

• #87
• #89
• #92
• #93
• #94
• #98

Here's the roadmap of basic functionalities for oras-dotnet to be involved for production use.

• Feature development
  • Models
    • Model Content Addressable Storage (CAS)
    • Model Tagging (TagResolver)
    • Model Target
    • Model Repository
    • Model Registry
  • Targets & Functions
    • Implement Memory Target
    • #37
    • Implement Remote Repository
      • #38
    • Implement Remote Registry
    • Copy graphs between Targets
    • #39
  • Utilities
    • #40
    • #41
    • #42
    • #43
  • Auth
    • #44
    • Support basic auth
    • #45
    • #46
    • #47
  • Performance
    • #48
    • #49
    • #50
• Build & release
  • #51
  • #91
  • #52
  • #53
  • #54
  • #55
  • #56
• Repository maintenance
  • Code documentation
  • #106
  • #57
  • #58
  • #59
  • #60
  • #61
  • #62
  • #63
  • #64
  • #65
  • #66