Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
vnf-onboarding
OSM Packages
Commits
83ee9a78
Commit
83ee9a78
authored
Oct 15, 2022
by
aticig
Browse files
Adding magma orc8r onboarding guide
parent
30ba1cd7
Changes
8
Hide whitespace changes
Inline
Side-by-side
Showing
8 changed files
with
209 additions
and
0 deletions
+209
-0
Hackfest_Demos/OSM-13/magma_orc_onboarding/README.md
Hackfest_Demos/OSM-13/magma_orc_onboarding/README.md
+125
-0
Hackfest_Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/1-onboard-packages.sh
.../OSM-MR13/2.1-KNF/magma-orc-scripts/1-onboard-packages.sh
+13
-0
Hackfest_Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/2-onboard-ns.sh
..._Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/2-onboard-ns.sh
+14
-0
Hackfest_Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/3-download-admin-operator-cert.sh
...1-KNF/magma-orc-scripts/3-download-admin-operator-cert.sh
+10
-0
Hackfest_Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/4-get-admin-operator-credential.sh
...-KNF/magma-orc-scripts/4-get-admin-operator-credential.sh
+10
-0
Hackfest_Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/5-get-magma-orc-gui-credential.sh
...1-KNF/magma-orc-scripts/5-get-magma-orc-gui-credential.sh
+10
-0
Hackfest_Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/6-get-loadbalancer-services.sh
.../2.1-KNF/magma-orc-scripts/6-get-loadbalancer-services.sh
+20
-0
Hackfest_Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/7-access-magma-orch-gui.sh
...MR13/2.1-KNF/magma-orc-scripts/7-access-magma-orch-gui.sh
+7
-0
No files found.
Hackfest_Demos/OSM-13/magma_orc_onboarding/README.md
0 → 100644
View file @
83ee9a78
# Magma Orchestrator NS
Descriptors that installs magma-orc8r using
[
Charmhub magma-orc8r bundle
](
https://charmhub.io/magma-orc8r?channel=beta
)
Orchestrator is a Magma service that provides a simple and consistent way to configure and monitor the wireless network securely.
The metrics acquired through the platform allows you to see the analytics and traffic flows of the wireless users through the Magma web UI.
For more information about Magma, see the official documentation
[
here
](
https://magmacore.org/
)
.
## Download Packages
```
bash
git clone
--recurse-submodules
-j8
https://osm.etsi.org/gitlab/vnf-onboarding/osm-packages.git
```
## Create the VIM Account
```
bash
# This is dummy vim account
export
VIM_ACCOUNT
=
openstack
osm vim-create
--name
$VIM_ACCOUNT
\
--account_type
dummy
\
--user
dummy
\
--password
dummy
\
--auth_url
"http://dummy"
\
--tenant
dummy
# Check the VIM account availability
osm vim-list
osm vim-show
$VIM_ACCOUNT
```
## Add K8s Cluster
```
bash
# kubeconfig.yaml exists in the HOME directory
export
K8S_NET
=
osm-ext
export
k8S_CLS_NAME
=
hackfest
osm k8scluster-add
--creds
~/kubeconfig.yaml
\
--vim
k8s-vim
\
--k8s-nets
"{k8s_net:
$K8S_NET
}"
\
--version
1.24
\
$K8S_CLS_NAME
# Check K8s cluster availability
osm k8scluster-list
osm k8scluster-show
$K8S_K8S_CLS_NAME
```
## Onboarding and instantiation
```
bash
# Define the NS name
export
MAGMA_NS_NAME
=
<ns name>
```
```
bash
osm nfpkg-create magma_orc_cnf
osm nspkg-create magma_orc_ns
osm ns-create
--ns_name
$MAGMA_NS_NAME
--nsd_name
magma_orc_cnf_ns
--vim_account
$VIM_ACCOUNT
--config
"{vld: [ {name: mgmtnet, vim-network-name:
$K8S_NET
}]}"
# Check NS status
osm ns-list
```
## Download the Admin Operator Https Certificate
```
bash
export
orc_model
=
juju models |
grep
-i
magma-orc |
awk
-F
" "
'{print $1}'
|
tr
-d
\*
juju switch
$orch_model
# admin_operator.pfx file should appear in the local path
juju scp
--container
=
"magma-orc8r-certifier"
orc8r-certifier/0:/var/opt/magma/certs/admin_operator.pfx admin_operator.pfx
```
## Run Day2 actions
### Get the Admin Operator Https Certificate credentials
```
bash
osm ns-action
$MAGMA_NS_NAME
--vnf_name
magma_orc_cnf
--kdu_name
magma-orc-kdu
--action_name
get-pfx-package-password
--wait
# pfx_package pass appears in the operation output, please save it
```
### Get the Magma Orchestrator GUI credentials
```
bash
osm ns-action
$MAGMA_NS_NAME
--vnf_name
magma_orc_cnf
--kdu_name
magma-orc-kdu
--action_name
get-master-admin-credentials
--wait
# admin-password and admin-username appear in the operation output, please save it
```
### Get Load Balancer Services
```
bash
LOAD_BALANCER_OP_ID
=
`
osm ns-action
$NS_NAME
--vnf_name
magma_orc_cnf
--kdu_name
magma-orc-kdu
--action_name
get-load-balancer-services
`
osm ns-op-show
$LOAD_BALANCER_OP_ID
# Load Balancer service names and External IP's are visible in the action output.
'nginx-proxy'
: <nginx-proxy External IP> -> master.nms.osm.magma.com
'orc8r-bootstrap-nginx'
: <orc8r-bootstrap-nginx External IP> -> bootstrapper-controller.osm.magma.com
'orc8r-clientcert-nginx'
: <orc8r-clientcert-nginx External IP> -> controller.osm.magma.com
'orc8r-nginx-proxy'
: <orc8r-nginx-proxy External IP> -> api.osm.magma.com
```
### User a DNS server register following Domains
```
bash
# Register the domains in PowerDNS server by running day2 actions:
ZONE
=
osm.magma.com.
# Sample registration for api.osm.magma.com
DOMAIN
=
api.
IP
=
<orc8r-nginx-proxy External IP>
# Test your records availability
# DNS_IP is your DNS server ip which is available as an environment variable.
dig @
${
DNS_IP
}
api.osm.magma.com
# Resolve the domain name directly from your machine.
dig api.osm.magma.com
```
## Access to Magma Orchestrator GUI
Open the browser and import the admin_operator.pfx using certificate import.
When it asks you a password, please enter pfx_package pass.
Try to reach following URL using your browser: https://master.nms.osm.magma.com.
Use the admin-username and admin-password to login.
Hackfest_Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/1-onboard-packages.sh
0 → 100755
View file @
83ee9a78
#!/bin/bash
echo
"========================================================================"
echo
"Upload VNFD"
echo
"========================================================================"
pushd
../../../OSM-13/
osm nfpkg-create magma_orc_cnf
echo
"========================================================================"
echo
"Upload NSD"
echo
"========================================================================"
osm nspkg-create magma_orc_ns
popd
Hackfest_Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/2-onboard-ns.sh
0 → 100755
View file @
83ee9a78
#!/bin/bash
export
MAGMA_NS_NAME
=
magma_orc_ns
export
VIM_ACCOUNT
=
openstack
export
K8S_NET
=
osm-ext
echo
"========================================================================"
echo
"Creating MAGMA_NS:
$MAGMA_NS_NAME
"
echo
"========================================================================"
osm ns-create
--ns_name
$MAGMA_NS_NAME
--nsd_name
magma_orc_cnf_ns
--vim_account
$VIM_ACCOUNT
--config
"{vld: [ {name: mgmtnet, vim-network-name:
$K8S_NET
}]}"
# Check NS status
osm ns-list
echo
"========================================================================"
echo
"Check NS status using osm ns-list, osm ns-show
$MAGMA_NS_NAME
"
echo
"========================================================================"
Hackfest_Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/3-download-admin-operator-cert.sh
0 → 100755
View file @
83ee9a78
#!/bin/bash
export
orc_model
=
`
juju models |
grep
-i
magma-orc |
awk
-F
" "
'{print $1}'
|
tr
-d
\*
`
juju switch
$orc_model
echo
$orch_model
echo
"========================================================================"
echo
"Dowloading admin_operator.pfx file to your current working directory"
echo
"========================================================================"
juju scp
--container
=
"magma-orc8r-certifier"
orc8r-certifier/0:/var/opt/magma/certs/admin_operator.pfx admin_operator.pfx
Hackfest_Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/4-get-admin-operator-credential.sh
0 → 100755
View file @
83ee9a78
#!/bin/bash
export
MAGMA_NS_NAME
=
magma_orc_ns
echo
"========================================================================"
echo
"Getting admin operator credentials"
echo
"========================================================================"
output
=
`
osm ns-action
$MAGMA_NS_NAME
--vnf_name
magma_orc_cnf
--kdu_name
magma-orc-kdu
--action_name
get-pfx-package-password
--wait
`
echo
"========================================================================"
echo
"pfx_package pass appears in the operation output, please save it"
echo
"========================================================================"
echo
$output
Hackfest_Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/5-get-magma-orc-gui-credential.sh
0 → 100755
View file @
83ee9a78
#!/bin/bash
export
MAGMA_NS_NAME
=
magma_orc_ns
echo
"========================================================================"
echo
"Getting Magma orchestrator GUI credentials"
echo
"========================================================================"
osm ns-action
$MAGMA_NS_NAME
--vnf_name
magma_orc_cnf
--kdu_name
magma-orc-kdu
--action_name
get-master-admin-credentials
--wait
echo
"========================================================================"
echo
"admin-password and admin-username appear in the operation output, please save it"
echo
"========================================================================"
Hackfest_Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/6-get-loadbalancer-services.sh
0 → 100755
View file @
83ee9a78
echo
"========================================================================"
echo
"Getting Loadbalancer services"
echo
"========================================================================"
export
MAGMA_NS_NAME
=
magma_orc_ns
osm ns-action
$MAGMA_NS_NAME
--vnf_name
magma_orc_cnf
--kdu_name
magma-orc-kdu
--action_name
get-load-balancer-services
--wait
echo
"========================================================================"
echo
"Load Balancer service names and External IP's are visible in the action output."
echo
"'nginx-proxy': <nginx-proxy External IP> -> master.nms.osm.magma.com"
echo
"'orc8r-bootstrap-nginx': <orc8r-bootstrap-nginx External IP> -> bootstrapper-controller.osm.magma.com"
echo
"'orc8r-clientcert-nginx': <orc8r-clientcert-nginx External IP> -> controller.osm.magma.com"
echo
"'orc8r-nginx-proxy': <orc8r-nginx-proxy External IP> -> api.osm.magma.com"
echo
"========================================================================"
echo
"========================================================================"
echo
"Register the domains in PowerDNS server by running day2 actions"
echo
"ZONE=osm.magma.com."
echo
"# Sample registration for api.osm.magma.com"
echo
"DOMAIN=api."
echo
"IP=<orc8r-nginx-proxy External IP> "
echo
"========================================================================"
Hackfest_Demos/OSM-MR13/2.1-KNF/magma-orc-scripts/7-access-magma-orch-gui.sh
0 → 100755
View file @
83ee9a78
#!/bin/bash
echo
"========================================================================"
echo
"Open the browser and import the admin_operator.pfx using certificate import."
echo
"When it asks you a password, please enter pfx_package pass."
echo
"Try to reach following URL using your browser: https://master.nms.osm.magma.com."
echo
"Use the admin-username and admin-password to login"
echo
"========================================================================"
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment