Skip to content

Commit 6833453

Browse files
authored
Merge pull request #5 from cybozu-go/add-limitations
Add image limitations section to design documentation
2 parents 76c6740 + af82322 commit 6833453

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/design.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This section describes user stories.
2929
- Assume that the Kubernetes cluster in the user stories is operated in an on-premises environment.
3030
- The team managing the Kubernetes cluster is referred to as the cluster administrators.
3131
- The team using the Kubernetes cluster is referred to as the tenant team.
32-
- Container images are downloaded from an external container registry over the internet.
32+
- Container images are downloaded from a upstream registry over the internet.
3333
- There is sufficient bandwidth from the cluster to the internet, but network throttling may occur if the network load becomes too high.
3434

3535
### User Story 1
@@ -48,6 +48,10 @@ The tenant team wants to pre-download images to minimize downtime during workloa
4848
### Limitations
4949

5050
- These features assume that [spegel](https://github.com/spegel-org/spegel) is running within the cluster.
51+
- Images downloaded by the operator are persisted in the node's local storage.
52+
As a result, any pod scheduled to the node can utilize these images without requiring image pull operations or valid registry credentials.
53+
This behavior may present security concerns in multi-tenant environments where private images are utilized, as it could potentially allow unauthorized access to container images containing confidential information.
54+
If this specification is not acceptable, please consider deploying admission webhooks such as [AlwaysPullImages](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#alwayspullimages) to enforce proper authentication for all image access operations.
5155

5256
### Risk and Mitigation
5357

@@ -107,7 +111,7 @@ subgraph Node1
107111
spegel-pod1[Spegel Pod]
108112
end
109113
110-
subgraph external
114+
subgraph upstream
111115
container-registry[Container Registry]
112116
end
113117
@@ -130,9 +134,9 @@ end
130134
131135
132136
%% Node1
133-
image-puller1-->|A1: Request to download container images from the registry mirror and external registry|containerd-node1
137+
image-puller1-->|A1: Request to download container images from the registry mirror and upstream registry|containerd-node1
134138
containerd-node1-->|A2: Attempt to download images from the registry mirror|spegel-pod1
135-
containerd-node1-->|A3: Attempt to download images from the external registry|container-registry
139+
containerd-node1-->|A3: Attempt to download images from the upstream registry|container-registry
136140
137141
%% Node2
138142
image-puller2-->|B1: Request to download container images from the registry mirror|containerd-node2

0 commit comments

Comments
 (0)