Skip to content

Commit c40ce28

Browse files
authored
Update get-started-with-cluster-registry.md
1 parent 8953de3 commit c40ce28

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

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

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.service: azure-operator-service-manager
1111
# Get started with Cluster Registry
1212
AOSM CNF CLUSTER REGISTRY
1313
* Original Author: Tobias Weisserth
14-
* Original Publish Date: 7/26/2024
14+
* Original Publish Date: July 26th, 2024
1515

1616
## Overview
1717
IMPROVING RESILIENCY FOR CLOUD NATIVE NETWORK FUNCTIONS WITH AZURE OPERATOR SERVICE MANAGER CLUSTER REGISTRY
@@ -20,32 +20,35 @@ Applies to:
2020
* AOSM ARM API Version: 2023-09-01
2121
* AOSM CNF Arc for Kubernetes Extension Build Number: 1.0.2711-7
2222

23-
## Overview
24-
Azure Operator Service Manager (AOSM) cluster registry enables a local copy of container images in the Nexus K8s cluster. When the containerized network function (CNF) is installed using AOSM with the cluster registry feature turned on, the container images are pulled from the AOSM Artifact Store (supported by Azure Container Registry) and saved locally in the cluster registry. This will ensure that the CNF running in the Nexus K8s cluster can access container images even if there are connectivity issues with the AOSM artifact store.
23+
## Introduction
24+
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 regitsry. With cluster register, CNF access to container images survives loss of connectivity to the remove artifact store.
2525

2626
### Key use cases
27-
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:
28-
* Pod restarts: pod restarts executed by stopping a pod and starting a pod might also result in the new pod being instantiated on a cluster node without the required images and resulting in container image pulls from that node.
29-
* Kubernetes scheduler operations: Kubernetes scheduler assigns pods to nodes and according to the scheduler profile, Kubernetes might re-assign pods to nodes to meet the profile criteria. This may result in pods being assigned by Kubernetes to nodes without required container images cached locally on the node.
27+
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:
28+
* Pod restarts: Stopping and starting a pod can result in a cluster node pulling container images from the registry.
29+
* Kubernetes scheduler operations: When reassigning pods to new nodes, according to scheduler profile rules, if the new node does not have the container images locally cached, the node will pull container images from the registry.
3030

31-
In the above scenarios, if there is a temporary issue with accessing the AOSM artifact store, the cluster registry will provide the necessary container images to prevent disruption to the running CNF. Also, the AOSM cluster registry feature will decrease the number of images pull requests on AOSM artifact store since each Nexus K8s node will pull container images from the cluster registry instead of the AOSM artifact store.
31+
In the above scenarios, if there is 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.
3232

3333
## How cluster registry works
34-
AOSM cluster registry is enabled using the Network Function Operator Arc K8s extension. The CLI example below shows how cluster registry is enabled on a Nexus K8s cluster.
34+
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.
3535
```
3636
az k8s-extension create --name networkfunction-operator --cluster-name <CLUSTER_NAME> --resource-group <RESOURCE_GROUP_NAME> --cluster-type connectedClusters --extension-type Microsoft.Azure.HybridNetwork --scope cluster --release-namespace azurehybridnetwork --config Microsoft.CustomLocation.ServiceAccount=azurehybridnetwork-networkfunctionoperator --config global.networkfunctionextension.enableClusterRegistry=true --config global.networkfunctionextension.clusterRegistry.storageSize=100Gi --version 1.0.2711-7 --auto-upgrade-minor-version false --release-train stable
3737
```
38-
When the cluster registry feature is enabled in the Network Function Operator Arc K8s extension, any container images deployed from AOSM artifact store will be accessible locally in the Nexus K8s cluster. The user can choose the persistent storage size for the cluster registry. If the user does not provide any input, a default persistent volume of 100GB will be set up to store the container images.
38+
When the cluster registry feature is enabled in the Network Function Operator Arc K8s extension, any container images deployed from AOSM artifact store are accessible locally in the Nexus K8s cluster. The user can choose the persistent storage size for the cluster registry.
39+
40+
> [!NOTE]
41+
> If the user does not provide any input, a default persistent volume of 100 GB is used.
3942
4043
## Frequently Asked Questions
4144

4245
### CAN I USE AOSM CLUSTER REGISTRY WITH A CNF APPLICATION PREVIOUSLY INSTALLED USING AOSM APIS?
43-
If there is a CNF application already installed using AOSM on a Nexus Kubernetes cluster, and the AOSM cluster registry feature is turned on, the cluster registry will not have the container images automatically. To use this feature, the cluster registry should be turned on before deploying the network function with AOSM.
46+
If there is a CNF application already installed using AOSM on a Nexus Kubernetes cluster, and the AOSM cluster registry feature is turned on, the cluster registry doest not have the container images automatically. To use this feature, the cluster registry should be turned on before deploying the network function with AOSM.
4447

4548
### WHICH NEXUS K8S STORAGE CLASS IS USED WITH AOSM CLUSTER REGISTRY?
46-
AOSM cluster registry feature uses nexus-volume storage class to store the container images in the Nexus Kubernetes cluster. By default, a 100GB persistent volume will be created if the user does not specify the size of the cluster registry.
49+
AOSM cluster registry feature uses nexus-volume storage class to store the container images in the Nexus Kubernetes cluster. By default, a 100 GB persistent volume is created if the user does not specify the size of the cluster registry.
4750

4851
### CAN I CHANGE THE STORAGE SIZE OF THE AOSM CLUSTER REGISTRY AFTER THE INITIAL
4952
DEPLOYMENT?
50-
It is important to plan for the persistent volume storage size before you install the cluster registry on the Nexus K8s cluster. It cannot be modified after the initial deployment. We recommend to configure the size of the volume by 3x to 4x of the starting installation size of the network function that goes on that cluster.
53+
It is important to plan for the persistent volume storage size before you install the cluster registry on the Nexus K8s cluster. It cannot be modified after the initial deployment. We recommend configuring the size of the volume by 3x to 4x of the starting installation size of the network function that goes on that cluster.
5154

0 commit comments

Comments
 (0)