diff --git a/README.md b/README.md index 6fcfeaac..8f912ca5 100644 --- a/README.md +++ b/README.md @@ -3,32 +3,34 @@ SPDX-FileCopyrightText: 2021 Open Networking Foundation -# amf +[![Go Report Card](https://goreportcard.com/badge/github.com/omec-project/amf)](https://goreportcard.com/report/github.com/omec-project/amf) -It is a control plane function in the 5G core network. AMF supports termination of NAS signalling, -NAS ciphering & integrity protection, registration management, connection management, mobility -management, access authentication and authorization, security context management. +# amf +It is a control plane function in the 5G core network. AMF supports termination +of NAS signalling, NAS ciphering & integrity protection, registration +management, connection management, mobility management, access authentication +and authorization, security context management. ## AMF Block Diagram ![AMF Block Diagram](/docs/images/README-AMF.png) -AMF takes configuration from Configuration Service. Configuration is handled at Network Slice level. -Configuration (Network Slices) can be added, removed & deleted. AMF has prometheus interface to export -metrics. Metrics include connected gNodeB's and its status. - -## The SD-Core AMF currently supports the following functionalities : -- Termination of RAN CP interface (N2). -- Termination of NAS (N1), NAS ciphering and integrity protection. -- Registration management. -- Connection management. -- Reachability management. -- Mobility Management. -- Provide transport for SM messages between UE and SMF. -- Transparent proxy for routing SM messages. -- Access Authentication. -- Access Authorization. +AMF takes configuration from Configuration Service. Configuration is handled at +Network Slice level. Configuration (Network Slices) can be added, removed and +deleted. AMF has prometheus interface to export metrics. Metrics include +connected gNodeB's and its status. + +## The SD-Core AMF currently supports the following functionalities: +- Termination of RAN CP interface (N2) +- Termination of NAS (N1), NAS ciphering and integrity protection +- Registration management +- Connection management +- Reachability management +- Mobility Management +- Provide transport for SM messages between UE and SMF +- Transparent proxy for routing SM messages +- Access Authentication +- Access Authorization ## Supported Procedures: - Registration/Deregistration @@ -45,9 +47,9 @@ metrics. Metrics include connected gNodeB's and its status. -Compliance of the 5G Network functions can be found at [5G Compliance ](https://docs.sd-core.opennetworking.org/master/overview/3gpp-compliance-5g.html) +Compliance of the 5G Network functions can be found at [5G Compliance](https://docs.sd-core.opennetworking.org/master/overview/3gpp-compliance-5g.html) -## Reach out to us thorugh +## Reach out to us thorugh 1. #sdcore-dev channel in [ONF Community Slack](https://onf-community.slack.com/) 2. Raise Github issues diff --git a/communication/api_individual_subscription_document.go b/communication/api_individual_subscription_document.go index 7c10abf5..2a6cc83a 100644 --- a/communication/api_individual_subscription_document.go +++ b/communication/api_individual_subscription_document.go @@ -21,9 +21,9 @@ import ( "github.com/omec-project/amf/logger" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" "github.com/omec-project/openapi/models" + "github.com/omec-project/util/httpwrapper" ) // AMFStatusChangeSubscribeModify - Namf_Communication AMF Status Change Subscribe Modify service Operation diff --git a/communication/api_individual_ue_context_document.go b/communication/api_individual_ue_context_document.go index 74b7d0c1..4b3262a8 100644 --- a/communication/api_individual_ue_context_document.go +++ b/communication/api_individual_ue_context_document.go @@ -23,9 +23,9 @@ import ( "github.com/omec-project/amf/logger" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" "github.com/omec-project/openapi/models" + "github.com/omec-project/util/httpwrapper" ) // CreateUEContext - Namf_Communication CreateUEContext service Operation diff --git a/communication/api_n1_n2_individual_subscription_document.go b/communication/api_n1_n2_individual_subscription_document.go index c4bc423a..32df8a56 100644 --- a/communication/api_n1_n2_individual_subscription_document.go +++ b/communication/api_n1_n2_individual_subscription_document.go @@ -21,9 +21,9 @@ import ( "github.com/omec-project/amf/logger" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" "github.com/omec-project/openapi/models" + "github.com/omec-project/util/httpwrapper" ) // N1N2MessageUnSubscribe - Namf_Communication N1N2 Message UnSubscribe (UE Specific) service Operation diff --git a/communication/api_n1_n2_message_collection_document.go b/communication/api_n1_n2_message_collection_document.go index 48e72068..4f15852e 100644 --- a/communication/api_n1_n2_message_collection_document.go +++ b/communication/api_n1_n2_message_collection_document.go @@ -23,9 +23,9 @@ import ( "github.com/omec-project/amf/logger" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" "github.com/omec-project/openapi/models" + "github.com/omec-project/util/httpwrapper" ) // N1N2MessageTransfer - Namf_Communication N1N2 Message Transfer (UE Specific) service Operation diff --git a/communication/api_n1_n2_subscriptions_collection_for_individual_ue_contexts_document.go b/communication/api_n1_n2_subscriptions_collection_for_individual_ue_contexts_document.go index 03095b72..e220e705 100644 --- a/communication/api_n1_n2_subscriptions_collection_for_individual_ue_contexts_document.go +++ b/communication/api_n1_n2_subscriptions_collection_for_individual_ue_contexts_document.go @@ -21,9 +21,9 @@ import ( "github.com/omec-project/amf/logger" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" "github.com/omec-project/openapi/models" + "github.com/omec-project/util/httpwrapper" ) func HTTPN1N2MessageSubscribe(c *gin.Context) { diff --git a/communication/api_subscriptions_collection_document.go b/communication/api_subscriptions_collection_document.go index 588ef872..0c1d8142 100644 --- a/communication/api_subscriptions_collection_document.go +++ b/communication/api_subscriptions_collection_document.go @@ -21,9 +21,9 @@ import ( "github.com/omec-project/amf/logger" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" "github.com/omec-project/openapi/models" + "github.com/omec-project/util/httpwrapper" ) // AMFStatusChangeSubscribe - Namf_Communication AMF Status Change Subscribe service Operation diff --git a/eventexposure/api_individual_subscription_document.go b/eventexposure/api_individual_subscription_document.go index e675f0d6..71a16b45 100644 --- a/eventexposure/api_individual_subscription_document.go +++ b/eventexposure/api_individual_subscription_document.go @@ -21,9 +21,9 @@ import ( "github.com/omec-project/amf/logger" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" "github.com/omec-project/openapi/models" + "github.com/omec-project/util/httpwrapper" ) // DeleteSubscription - Namf_EventExposure Unsubscribe service Operation diff --git a/eventexposure/api_subscriptions_collection_document.go b/eventexposure/api_subscriptions_collection_document.go index e89c9275..32da764c 100644 --- a/eventexposure/api_subscriptions_collection_document.go +++ b/eventexposure/api_subscriptions_collection_document.go @@ -21,9 +21,9 @@ import ( "github.com/omec-project/amf/logger" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" "github.com/omec-project/openapi/models" + "github.com/omec-project/util/httpwrapper" ) // CreateSubscription - Namf_EventExposure Subscribe service Operation diff --git a/httpcallback/api_am_policy_control_update_notify.go b/httpcallback/api_am_policy_control_update_notify.go index fe6ce26c..8b58bb3b 100644 --- a/httpcallback/api_am_policy_control_update_notify.go +++ b/httpcallback/api_am_policy_control_update_notify.go @@ -12,9 +12,9 @@ import ( "github.com/omec-project/amf/logger" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" "github.com/omec-project/openapi/models" + "github.com/omec-project/util/httpwrapper" ) func HTTPAmPolicyControlUpdateNotifyUpdate(c *gin.Context) { diff --git a/httpcallback/api_n1_message_notify.go b/httpcallback/api_n1_message_notify.go index 28143566..6a94be4d 100644 --- a/httpcallback/api_n1_message_notify.go +++ b/httpcallback/api_n1_message_notify.go @@ -12,9 +12,9 @@ import ( "github.com/omec-project/amf/logger" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" "github.com/omec-project/openapi/models" + "github.com/omec-project/util/httpwrapper" ) func HTTPN1MessageNotify(c *gin.Context) { diff --git a/httpcallback/api_nf_subscribe_notify.go b/httpcallback/api_nf_subscribe_notify.go index 7375cf5c..a4736218 100644 --- a/httpcallback/api_nf_subscribe_notify.go +++ b/httpcallback/api_nf_subscribe_notify.go @@ -14,8 +14,8 @@ import ( "github.com/omec-project/openapi/models" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" + "github.com/omec-project/util/httpwrapper" ) func HTTPNfSubscriptionStatusNotify(c *gin.Context) { diff --git a/httpcallback/api_sm_context_status_notify.go b/httpcallback/api_sm_context_status_notify.go index 0d6be14a..10d79d69 100644 --- a/httpcallback/api_sm_context_status_notify.go +++ b/httpcallback/api_sm_context_status_notify.go @@ -12,9 +12,9 @@ import ( "github.com/omec-project/amf/logger" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" "github.com/omec-project/openapi/models" + "github.com/omec-project/util/httpwrapper" ) func HTTPSmContextStatusNotify(c *gin.Context) { diff --git a/location/api_individual_ue_context_document.go b/location/api_individual_ue_context_document.go index 8bd3f0e4..ce19a9a5 100644 --- a/location/api_individual_ue_context_document.go +++ b/location/api_individual_ue_context_document.go @@ -21,9 +21,9 @@ import ( "github.com/omec-project/amf/logger" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" "github.com/omec-project/openapi/models" + "github.com/omec-project/util/httpwrapper" ) // ProvideLocationInfo - Namf_Location ProvideLocationInfo service Operation diff --git a/mt/api_ue_context_document.go b/mt/api_ue_context_document.go index 82f5debf..92bcfe81 100644 --- a/mt/api_ue_context_document.go +++ b/mt/api_ue_context_document.go @@ -21,9 +21,9 @@ import ( "github.com/omec-project/amf/logger" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" "github.com/omec-project/openapi/models" + "github.com/omec-project/util/httpwrapper" ) // ProvideDomainSelectionInfo - Namf_MT Provide Domain Selection Info service Operation diff --git a/oam/api_registered_ue_context.go b/oam/api_registered_ue_context.go index 7dc19ded..c0b3e32b 100644 --- a/oam/api_registered_ue_context.go +++ b/oam/api_registered_ue_context.go @@ -12,9 +12,9 @@ import ( "github.com/omec-project/amf/logger" "github.com/omec-project/amf/producer" - "github.com/omec-project/util/httpwrapper" "github.com/omec-project/openapi" "github.com/omec-project/openapi/models" + "github.com/omec-project/util/httpwrapper" ) func setCorsHeader(c *gin.Context) {