From f6067753e37737c476db4009598114b0cec610da Mon Sep 17 00:00:00 2001 From: Guillaume Belanger Date: Fri, 22 Sep 2023 13:11:05 -0400 Subject: [PATCH] [feat] Add links for all SD-Core charms --- docs/reference/charms.md | 16 +++++++++++++ docs/reference/deployment_options.md | 32 ++++++++++++++++++++++++++ docs/reference/index.md | 34 ++++------------------------ 3 files changed, 52 insertions(+), 30 deletions(-) create mode 100644 docs/reference/charms.md create mode 100644 docs/reference/deployment_options.md diff --git a/docs/reference/charms.md b/docs/reference/charms.md new file mode 100644 index 0000000..7c34920 --- /dev/null +++ b/docs/reference/charms.md @@ -0,0 +1,16 @@ +# Charms + +Each charm has its own source code repository and CharmHub page. Configuration options and specific charm usage instructions are available on the CharmHub page. + +| Charm | Reference | +|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SD-Core AMF | {bdg-link-primary-line}`GitHub ` {bdg-link-primary-line}`CharmHub ` | +| SD-Core AUSF | {bdg-link-primary-line}`GitHub ` {bdg-link-primary-line}`CharmHub ` | +| SD-Core NRF | {bdg-link-primary-line}`GitHub ` {bdg-link-primary-line}`CharmHub ` | +| SD-Core NSSF | {bdg-link-primary-line}`GitHub ` {bdg-link-primary-line}`CharmHub ` | +| SD-Core PCF | {bdg-link-primary-line}`GitHub ` {bdg-link-primary-line}`CharmHub ` | +| SD-Core SMF | {bdg-link-primary-line}`GitHub ` {bdg-link-primary-line}`CharmHub ` | +| SD-Core UDM | {bdg-link-primary-line}`GitHub ` {bdg-link-primary-line}`CharmHub ` | +| SD-Core UDR | {bdg-link-primary-line}`GitHub ` {bdg-link-primary-line}`CharmHub ` | +| SD-Core UPF | {bdg-link-primary-line}`GitHub ` {bdg-link-primary-line}`CharmHub ` | +| SD-Core Webui | {bdg-link-primary-line}`GitHub ` {bdg-link-primary-line}`CharmHub ` | diff --git a/docs/reference/deployment_options.md b/docs/reference/deployment_options.md new file mode 100644 index 0000000..8031f70 --- /dev/null +++ b/docs/reference/deployment_options.md @@ -0,0 +1,32 @@ +# SD-Core deployment options + +`````{tab-set} + +````{tab-item} Single site deployment + +Use the `sdcore` bundle to deploy a standalone 5G core network. +This bundle contains the 5G control plane functions, the UPF, Webui, Grafana Agent, Self Signed +Certificates and MongoDB. + +```{image} ../images/sdcore_single_site.png +:alt: Single site deployment +:height: 600 +:align: center +``` + +```` + +````{tab-item} Edge deployment + +Use the `sdcore-control-plane` to deploy the 5G control plane in a central place and the +`sdcore-user-plane` bundle to deploy the 5G user plane in edge sites. + +```{image} ../images/sdcore_edge.png +:alt: Edge deployment +:height: 600 +:align: center +``` + +```` + +````` diff --git a/docs/reference/index.md b/docs/reference/index.md index 2303eab..45867fa 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -1,34 +1,8 @@ # Reference -## SD-Core deployment options +```{toctree} +:maxdepth: 1 -`````{tab-set} - -````{tab-item} Single site deployment - -Use the `sdcore` bundle to deploy a standalone 5G core network. -This bundle contains the 5G control plane functions, the UPF, Webui, Grafana Agent, Self Signed -Certificates and MongoDB. - -```{image} ../images/sdcore_single_site.png -:alt: Single site deployment -:height: 600 -:align: center +charms +deployment_options ``` - -```` - -````{tab-item} Edge deployment - -Use the `sdcore-control-plane` to deploy the 5G control plane in a central place and the -`sdcore-user-plane` bundle to deploy the 5G user plane in edge sites. - -```{image} ../images/sdcore_edge.png -:alt: Edge deployment -:height: 600 -:align: center -``` - -```` - -`````