Mirrors/flux2
1
0
Fork 0
mirror of synced 2026-02-09 19:55:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

RFC: add revision format example for Buckets

Browse Source 
Signed-off-by: Hidde Beydals <hello@hidde.co>
This commit is contained in:
Hidde Beydals
2022-10-21 07:49:41 +00:00
parent fa217b8775
commit 2c12385344
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
rfcs/XXXX-artifact-revision-format/README.md
View File

@@ -9,7 +9,7 @@ Must be one of `provisional`, `implementable`, `implemented`, `deferred`, `rejec
**Creation date:** 2022-10-20 **Creation date:** 2022-10-20
**Last update:** 2022-10-20 **Last update:** 2022-10-21
## Summary ## Summary
@@ -17,8 +17,8 @@ This RFC proposes to establish a canonical format for an `Artifact` which
points to a specific checksum (e.g. an OCI manifest digest or Git commit SHA) points to a specific checksum (e.g. an OCI manifest digest or Git commit SHA)
of a named pointer (e.g. an OCI image tag or Git tag). In addition, it proposes of a named pointer (e.g. an OCI image tag or Git tag). In addition, it proposes
to include the algorithm name (e.g. `sha256`) as a prefix to any advertised to include the algorithm name (e.g. `sha256`) as a prefix to any advertised
checksum in an `Artifact` and further referring to it as a `Digest` opposed to checksum in an `Artifact` and further referring to it as a `Digest` as opposed
a `Checksum`. to a `Checksum`.
## Motivation ## Motivation
@@ -67,7 +67,7 @@ with supportive response from Core Maintainers.
checksums. This has promising performance improvements over SHA-256, which checksums. This has promising performance improvements over SHA-256, which
could allow for performance improvements in large scale environments. could allow for performance improvements in large scale environments.
- Allow compatability with SemVer name references which might contain an `@` - Allow compatability with SemVer name references which might contain an `@`
symbol already (e.g. `package@v1.0.0@sha256:...`, opposed to OCI's symbol already (e.g. `package@v1.0.0@sha256:...`, as opposed to OCI's
`tag:v1.0.0@sha256:...`). `tag:v1.0.0@sha256:...`).
### Non-Goals ### Non-Goals
@@ -108,6 +108,13 @@ without a defined branch or tag, the `Revision` field value would become:
sha1:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 sha1:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
``` ```
For a `Bucket`'s `Artifact` with a revision based on an SHA-256 calculation of
a list of object keys and their etags, the `Revision` field value would become:
```text
sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
```
### Change the Artifact Checksum to a Digest ### Change the Artifact Checksum to a Digest
Change the format of the `Checksum` field of the `source.toolkit.fluxcd.io` Change the format of the `Checksum` field of the `source.toolkit.fluxcd.io`