6
6
[ ![ CodeQL]] [ code-ql ]
7
7
[ ![ Go Report Card]] [ go-report-card ]
8
8
[ ![ codecov]] [ code-cov ]
9
-
10
- ![ cluster-ops]
9
+ [ ![ release-tag]] [ peerd-pkgs ]
11
10
12
11
This project implements peer to peer distribution of content (such as content-addressable files or OCI container images)
13
12
in a Kubernetes cluster. The source of the content could be another node in the same cluster, an OCI container registry
14
13
(like Azure Container Registry) or a remote blob store (such as Azure Blob Storage).
15
14
15
+ ![ cluster-ops]
16
+
16
17
#### Important Disclaimer
17
18
18
19
This is ** work in progress** and not yet production ready. We are actively working on this project and would love to
@@ -28,8 +29,6 @@ If you have a k8s cluster that uses containerd as the runtime, you can use the p
28
29
pods on every node. With containerd, Peerd leverages the [ hosts configuration] [ containerd hosts ] to act as a mirror for
29
30
container images.
30
31
31
- [ ![ release-tag]] [ peerd-pkgs ]
32
-
33
32
``` bash
34
33
CLUSTER_CONTEXT=< your-cluster-context> && \
35
34
TAG=< docker-image-tag> && \
@@ -62,11 +61,9 @@ To see logs from the Peerd pods, run the following.
62
61
kubectl --context=$CLUSTER_CONTEXT -n peerd-ns logs -l app=peerd -f
63
62
```
64
63
65
- Further details on building can be found in [ build.md] .
66
-
67
64
## Features
68
65
69
- * ** Peer to Peer File Sharing** : Peerd llows a node to act as a mirror for files obtained from any HTTP upstream source
66
+ * ** Peer to Peer File Sharing** : Peerd allows a node to act as a mirror for files obtained from any HTTP upstream source
70
67
(such as an [ Azure Blob] using a [ SAS URL] ), and can discover and serve a specified byte range of the file to/from
71
68
other nodes in the cluster. Peerd will first attempt to discover and serve this range from its peers. If not found, it
72
69
will fallback to download the range from the upstream URL. Peerd caches downloaded ranges as well as optionally, can
@@ -91,6 +88,10 @@ Further details on building can be found in [build.md].
91
88
92
89
The APIs are described in the [ swagger.yaml] .
93
90
91
+ ## Build
92
+
93
+ See [ build.md] .
94
+
94
95
## Design and Architecture
95
96
96
97
See [ design.md] .
0 commit comments