Skip to content

Commit 38b8bfc

Browse files
authored
Update get-started-with-cluster-registry.md
updates for webhook
1 parent 373c0bb commit 38b8bfc

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

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

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,20 @@ Improve resiliency for cloud native network functions with Azure Operator Servic
1919
* First version, with HA for NF kubernetes extension: 2.0.2810-144
2020

2121
## Introduction
22-
Azure Operator Service Manager (AOSM) cluster registry (CR) enables a local copy of container images in the Nexus K8s cluster. When the containerized network function (CNF) is installed with cluster registry enabled, the container images are pulled from the remote AOSM artifact store and saved to a local registry. With cluster register, CNF access to container images survives loss of connectivity to the remote artifact store.
22+
Azure Operator Service Manager (AOSM) cluster registry (CR) enables a local copy of container images in the Nexus K8s cluster. When the containerized network function (CNF) is installed with cluster registry enabled, the container images are pulled from the remote AOSM artifact store and saved to this local cluster registry. Leveraging a mutating webhook, cluster registry automatically interccepts image requests and substitutes the local registry path, to avoid publisher packaging changes. With cluster register, CNF access to container images survives loss of connectivity to the remote artifact store.
2323

24-
### Key use cases
24+
### Key use cases and benefits
2525
Cloud native network functions (CNF) need access to container images, not only during the initial deployment using AOSM artifact store, but also to keep the network function operational. Some of these scenarios include:
2626
* Pod restarts: Stopping and starting a pod can result in a cluster node pulling container images from the registry.
2727
* Kubernetes scheduler operations: During pod to node assignments, according to scheduler profile rules, if the new node does not have the container images locally cached, the node pulls container images from the registry.
2828

29-
In the above scenarios, if there's a temporary issue with accessing the AOSM artifact store, the cluster registry provides the necessary container images to prevent disruption to the running CNF. Also, the AOSM cluster registry feature decreases the number of image pull requests on AOSM artifact store since each Nexus K8s node pulls container images from the cluster registry instead of the AOSM artifact store.
29+
Benefits of using AOSM cluster registry:
30+
* Provides the necessary local images to prevent CNF disruption where connectivity to AOSM artifact store is lost.
31+
* Decreases the number of image pulls on AOSM artifact store, since each cluster node now pulls images only from the local registry.
32+
* Overcomes issues with malformed registry URLs, by using a mutating webhook to substitute the proper local regitsry URL path.
3033

3134
## How cluster registry works
32-
AOSM cluster registry is enabled using the Network Function Operator Arc K8s extension. The following CLI shows how cluster registry is enabled on a Nexus K8s cluster.
35+
AOSM cluster registry is enabled using the Network Function Operator (NFO) Arc K8s extension. The following CLI shows how cluster registry is enabled on a Nexus K8s cluster.
3336
```bash
3437
az k8s-extension create --cluster-name
3538
--cluster-type {connectedClusters}
@@ -58,6 +61,23 @@ When the cluster registry feature is enabled in the Network Function Operator Ar
5861
> [!NOTE]
5962
> If the user doesn't provide any input, a default persistent volume of 100 GB is used.
6063
64+
## Cluster registry components
65+
The cluster registry feature deploys a number of helper pods on the target edge cluster to assist the NFO extension.
66+
67+
### Component reconciler
68+
* This main pod takes care of reconciling component Custom Resource Objects (CROs) created by K8sBridge with the help of the Microsoft.Kubernetes RP, Hybrid Relay and Arc agentry running on the cluster.
69+
70+
### Pod mutating webhook
71+
* These pods implement Kubernetes mutating admission webhooks, serving an instance of the mutate API. The mutate API does two things:
72+
* It modifies the image registry path to the local registry IP, substituting out the AOSM artifact store ACR.
73+
* It creates an Artifact CR on the edge cluster.
74+
75+
### Artifact reconciler
76+
* This pod reconciles artifact CROs created by the mutating webhook.
77+
78+
### Registry
79+
* This pod stores and retrieves container images for CNF.
80+
6181
## High availability and resiliency considerations
6282
The AOSM NF extension relies uses a mutating webhook and edge registry to support key features.
6383
* Onboarding helm charts without requiring customization of image path.

0 commit comments

Comments
 (0)