ocilot 0.1.0

cli and library for interacting with OCI registries
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

use std::num::ParseIntError;

use reqwest::header::ToStrError;
use snafu::Snafu;
use tokio::task::JoinError;
use url::Url;

use crate::models::{ErrorResponse, Platform};
use crate::uri::Uri;

#[derive(Snafu, Debug)]
#[snafu(visibility(pub))]
pub enum Error {
    #[snafu(display("failed to interact with tar archive: {source}"))]
    Archive { source: std::io::Error },
    #[snafu(display("failed to authorize with oci registry: {reason}"))]
    Authorization { reason: String },
    #[snafu(display("blob with digest {digest} is missing from oci archive"))]
    BlobMissing { digest: String },
    #[snafu(display("failed to deserialize image configuration received from registry: {source}"))]
    ConfigDeserialize { source: serde_json::Error },
    #[snafu(display("oci registry did not return the content length"))]
    ContentLengthMissing,
    #[snafu(display("content-length was not a valid number: {source}"))]
    ContentLengthNotNumber { source: ParseIntError },
    #[snafu(display("oci registry did not return a proper header"))]
    ImproperHeader { source: ToStrError },
    #[snafu(display("failed to deserialize response body: {source}"))]
    BodyDeserialize { source: serde_json::Error },
    #[snafu(display("failed to delete blob '{digest}': {reason}"))]
    DeleteBlob {
        digest: String,
        reason: ErrorResponse,
    },
    #[snafu(display("cannot delete a blob without a specific digest"))]
    DeleteBlobNoDigest,
    #[snafu(display("failed to delete tag '{tag}': {reason}"))]
    DeleteTag { tag: String, reason: ErrorResponse },
    #[snafu(display("cannot delete a tag via a sha256 digest"))]
    DeleteTagDigest,
    #[snafu(display("failed to perform operation with directory: {source}"))]
    Directory { source: std::io::Error },
    #[snafu(display("cannot read a blob without a specific digest uri (uri: {uri})"))]
    DirectLoadBlob { uri: Uri },
    #[snafu(display("cannot direct load an image without a specific digest uri (uri: {uri})"))]
    DirectLoadImage { uri: Uri },
    #[snafu(display("failed to deserialize error response from oci registry: {source}"))]
    ErrorDeserialize { source: reqwest::Error },
    #[snafu(display("failed to fetch blob: {reason}"))]
    FetchBlob { reason: ErrorResponse },
    #[snafu(display("failed to fetch index: {reason}"))]
    FetchIndex { reason: ErrorResponse },
    #[snafu(display("failed to fetch manifest: {reason}"))]
    FetchManifest { reason: ErrorResponse },
    #[cfg(feature = "aws")]
    #[snafu(display("failed to fetch tags from public ecr: {reason}"))]
    FetchTagsAws { reason: String },
    #[snafu(display("failed to interact with local file: {source}"))]
    File { source: std::io::Error },
    #[snafu(display("failed to finish blob upload: {reason}"))]
    FinishBlob { reason: ErrorResponse },
    #[snafu(display("oci image archive has invalid index: {source}"))]
    ImageInvalidIndex { source: serde_json::Error },
    #[snafu(display("oci image archive does not have a valid manifest: {source}"))]
    ImageInvalidManifest { source: serde_json::Error },
    #[snafu(display("index does not contain an image for the platform: {platform}"))]
    IndexNoPlatform { platform: Platform },
    #[snafu(display("no image was found in oci registry matching: {uri}"))]
    ImageNotFound { uri: Uri },
    #[snafu(display("file is not a valid oci archive as it is missing index.json"))]
    ImageNotValid,
    #[snafu(display("invalid algorithm in digest: {algorithm}"))]
    InvalidAlgorithm { algorithm: String },
    #[snafu(display("failed to unpack archive from layer: {source}"))]
    LayerArchive { source: std::io::Error },
    #[snafu(display("failed to copy from layer: {source}"))]
    LayerCopy { source: std::io::Error },
    #[snafu(display("failed to wait for layer operation: {source}"))]
    LayerWait { source: JoinError },
    #[snafu(display("failed to read from layer: {source}"))]
    LayerRead { source: std::io::Error },
    #[snafu(display("failed to write layer: {source}"))]
    LayerWrite { source: std::io::Error },
    #[snafu(display("failed to list repositories in registry: {reason}"))]
    ListRepos { reason: ErrorResponse },
    #[snafu(display("failed to list tags in repository: {reason}"))]
    ListTags { reason: ErrorResponse },
    #[snafu(display("malformed object uri provided: {reason}"))]
    MalformedUri { reason: String },
    #[snafu(display("no image index found at uri: {uri}"))]
    NoIndex { uri: Uri },
    #[snafu(display("failed to push image to '{uri}': {reason}"))]
    PushImage { uri: Url, reason: ErrorResponse },
    #[snafu(display("failed to make request to oci registry: {source}"))]
    Request { source: reqwest::Error },
    #[snafu(display("failed to parse response from oci registry: {source}"))]
    ResponseDeserialize { source: reqwest::Error },
    #[snafu(display("failed to serialize to json: {source}"))]
    Serialize { source: serde_json::Error },
    #[snafu(display("failed to start a blob upload: {reason}"))]
    StartBlobUpload { reason: ErrorResponse },
    #[snafu(display("registry did not provide an upload_url for blob upload"))]
    StartBlobNoLocation,
    #[snafu(display("failed to create temporary directory: {source}"))]
    Temp { source: std::io::Error },
    #[snafu(display("upload of chunk for blob failed: {reason}"))]
    Upload { reason: ErrorResponse },
    #[snafu(display("invalid url detected: {source}"))]
    Url { source: url::ParseError },
}