pf-registry 1.0.13

ProcessFork registry adapters: file, Hugging Face Hub, S3-compatible, IPFS, local OCI
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

// SPDX-License-Identifier: MIT
//! IPFS adapter — uploads `.pfimg` artifacts into a local Kubo daemon,
//! returns a directory CID that can be served from any IPFS gateway.
//!
//! Maps `ipfs://<CID>` to a UnixFS directory containing
//! `manifest.json`, `manifest.json.sig`, and one entry per
//! transitively-reachable blob.
//!
//! Push semantics: IPFS is content-addressed, so the resulting CID is
//! determined by what we upload — we can't hit a caller-supplied CID
//! exactly. The CID returned by the daemon is emitted via
//! `tracing::info!(target = "pf-registry::ipfs", cid = ...)` so the
//! caller can pick it up from logs (and `pf push` surfaces it on
//! stdout). The `cid` in the [`ImageRef::Ipfs`] target acts as a
//! re-push hint only.
//!
//! Pull semantics: pass a known directory CID, the adapter walks it
//! and reconstructs the [`crate::registry::LayerSet`].
//!
//! ## Auth / endpoint
//!
//! Default daemon endpoint is `http://127.0.0.1:5001`. Override via
//! `auth["IPFS_API"]` or env `IPFS_API`.

#[cfg(feature = "ipfs-live")]
mod live;
#[cfg(feature = "ipfs-live")]
pub use live::IpfsRegistry;

#[cfg(not(feature = "ipfs-live"))]
use crate::image_ref::ImageRef;
#[cfg(not(feature = "ipfs-live"))]
use crate::registry::{LayerSet, Registry, RegistryError};
#[cfg(not(feature = "ipfs-live"))]
use async_trait::async_trait;
#[cfg(not(feature = "ipfs-live"))]
use pf_core::cas::BlobStore;
#[cfg(not(feature = "ipfs-live"))]
use pf_core::manifest::Manifest;

#[cfg(not(feature = "ipfs-live"))]
#[derive(Debug, Default)]
pub struct IpfsRegistry {
    _endpoint: String,
}

#[cfg(not(feature = "ipfs-live"))]
impl IpfsRegistry {
    /// Construct an IPFS registry stub. Rebuild with
    /// `--features ipfs-live` (default since v1.0.2) for the live path.
    pub fn new(endpoint: String) -> Self {
        Self {
            _endpoint: endpoint,
        }
    }
}

#[cfg(not(feature = "ipfs-live"))]
fn err() -> RegistryError {
    RegistryError::UnsupportedScheme(
        "ipfs:// — pf-registry built without `ipfs-live`. Rebuild with \
         `--features ipfs-live` (default since v1.0.2) to enable IPFS."
            .into(),
    )
}

#[cfg(not(feature = "ipfs-live"))]
#[async_trait]
impl Registry for IpfsRegistry {
    async fn push(
        &self,
        _: &ImageRef,
        _: &Manifest,
        _: &dyn BlobStore,
    ) -> Result<(), RegistryError> {
        Err(err())
    }
    async fn pull(&self, _: &ImageRef) -> Result<LayerSet, RegistryError> {
        Err(err())
    }
    async fn exists(&self, _: &ImageRef) -> Result<bool, RegistryError> {
        Err(err())
    }
}