Skip to content

Commit 0ec42bd

Browse files
authored
Update get-started-with-cluster-registry.md
1 parent 458a8f8 commit 0ec42bd

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

articles/operator-service-manager/get-started-with-cluster-registry.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,19 +81,19 @@ The cluster registry feature deploys helper pods on the target edge cluster to a
8181
### Cluster registry garbage collection
8282
AOSM cluster extension runs a background job to regularly clean up container images. The job schedule and conditions are configured by end-user, but by default the job runs once per days at a 0% utilization threshold. This job will check if the cluster registry usage has reached the specified threshold, and if so, it will initiate the garbage collection process.
8383

84-
#### AOSM cluster extension clean up garbage image manifests
84+
#### Clean up garbage image manifests
8585
AOSM maintains references between pod owner resource and consuming images in cluster registry. Upon initiating the images cleanup process, images will be identified which are not linked to any pods, issuing a soft delete to remove them from cluster registry. This type of soft delete doesn't immediately free cluster registry storage space. Actual image files removal depends on the CNCF distribution registry garbage collection outlined below.
8686

8787
> [!NOTE]
8888
> The reference between a pod's owner and its container images ensures that AOSM does not mistakenly delete images. For example, if a replicaset pod goes down, AOSM will not dereference the container images. AOSM only dereferences container images when the replicaset is deleted. The same principle applies to pods managed by Kubernetes jobs and daemonsets.
8989
90-
#### CNCF distribution registry garbage collection
90+
#### CNCF garbage collection distribution
9191
AOSM sets up the cluster registry using open source [CNCF distribution registry](https://distribution.github.io/distribution/). Therefore, AOSM relies on garbage collection capabilities that provided by [Garbage collection | CNCF Distribution](https://distribution.github.io/distribution/about/garbage-collection/#:~:text=About%20garbage%20collection,considerable%20amounts%20of%20disk%20space.). Overall, it follows standard 2 phase “mark and sweep” process to delete image files to free registry storage space.
9292

9393
> [!NOTE]
9494
> This process requires the cluster registry in read-only mode. If images are uploaded when registry not in read-only mode, there is the risk that images layers are mistakenly deleted leading to a corrupted image. Registry requires lock in read-only mode for a duration of up to 1 minute. Consequently, AOSM will defer other NF deployment when cluster registry in read-only mode.
9595
96-
#### Configuration
96+
#### Garbage collection configuration parameters
9797
Customers can adjust the following settings to configure the schedule and conditions for the garbage collection job.
9898
* global.networkfunctionextension.clusterRegistry.clusterRegistryGCCadence
9999
* global.networkfunctionextension.clusterRegistry.clusterRegistryGCThreshold

0 commit comments

Comments
 (0)