Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 1.42 KB

COMPATIBILITY.md

File metadata and controls

23 lines (18 loc) · 1.42 KB

Compatibility

Currently, Spegel only works with Containerd, in the future other container runtime interfaces may be supported. Spegel relies on Containerd registry mirroring to route requests to the correct destination. This requires Containerd to be properly configured, if it is not Spegel will exit. First of all the registry config path needs to be set, this is not done by default in Containerd. Second of all discarding unpacked layers cannot be enabled. Some Kubernetes flavors come with this setting out of the box, while others do not. Spegel is not able to write this configuration for you as it requires a restart of Containerd to take effect.

version = 2

[plugins."io.containerd.grpc.v1.cri".registry]
   config_path = "/etc/containerd/certs.d"
[plugins."io.containerd.grpc.v1.cri".containerd]
   discard_unpacked_layers = false

Spegel has been tested on the following Kubernetes flavors for compatibility. Some flavors may require additional steps while others will work right out of the box.

Flavor Status Comment
AKS 🟢 Verified to work out of the box.
EKS 🟡 Discard unpacked layers is enabled by default and needs to be disabled.
GKE 🔴 Not supported due to registry config path not being set.
Minikube 🟢 Verified to work out of the box.