Docs: keep rules of name in the same way

[pti/o2.git] / docs / user-guide.rst

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 9a11012..d1559d8 100644 (file)
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -2,43 +2,52 @@
 .. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright (C) 2021 Wind River Systems, Inc.
 
 .. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright (C) 2021 Wind River Systems, Inc.
 

-O-Cloud O2 Service User Guide
-=============================
+INF O2 Service User Guide
+=========================

 
 

-This guide will introduce the process that make O2 interface work with
+This guide will introduce the process that make INF O2 interface work with

 SMO.
 
 SMO.
 

--  Assume you have an O-Cloud O2 environment
+-  Assume you have an O2 service with INF platform environment

 
 

--  Discover O-Cloud inventory
+   .. code:: bash

 
 

-   -  O-Cloud auto discovery
+      export OAM_IP=<INF_OAM_IP>

 
 

-      After you installed the O-Cloud service, it will automatically
+-  Discover INF platform inventory
+
+   -  INF platform auto discovery
+
+      After you installed the INF O2 service, it will automatically

       discover the INF through the parameters that you give from the
       “*o2service-override.yaml*”
 
       discover the INF through the parameters that you give from the
       “*o2service-override.yaml*”
 

-      Below command can get the O-Cloud information
+      Below command can get the INF platform information as O-Cloud

 
       .. code:: shell
 
          curl -X 'GET' \
 
       .. code:: shell
 
          curl -X 'GET' \

-           'http://<OAM IP>:30205/o2ims_infrastructureInventory/v1/' \
+           "http://${OAM_IP}:30205/o2ims_infrastructureInventory/v1/" \

            -H 'accept: application/json'
 
    -  Resource pool
 
            -H 'accept: application/json'
 
    -  Resource pool
 

-      One O-Cloud have one resource pool, all the resources that belong
-      to this O-Cloud will be organized into this resource pool
+      One INF platform have one resource pool, all the resources that belong
+      to this INF platform will be organized into this resource pool

 
       Get the resource pool information through this interface
 
       .. code:: shell
 
          curl -X 'GET' \
 
       Get the resource pool information through this interface
 
       .. code:: shell
 
          curl -X 'GET' \

-           'http://<OAM IP>:30205/o2ims_infrastructureInventory/v1/resourcePools' \
+           "http://${OAM_IP}:30205/o2ims_infrastructureInventory/v1/resourcePools" \

            -H 'accept: application/json'
 
            -H 'accept: application/json'
 

+         # export resource pool id
+         export resourcePoolId=`curl -X 'GET'   "http://${OAM_IP}:30205/o2ims_infrastructureInventory/v1/resourcePools"   -H 'accept: application/json' -H 'X-Fields: resourcePoolId' 2>/dev/null | jq .[].resourcePoolId | xargs echo`
+
+         echo ${resourcePoolId} # check the exported resource pool id
+

    -  Resource type
 
       Resource type defined what type is the specified resource, like a
    -  Resource type
 
       Resource type defined what type is the specified resource, like a


@@ -49,7 +58,7 @@ SMO.
       .. code:: shell
 
          curl -X 'GET' \
       .. code:: shell
 
          curl -X 'GET' \

-           'http://<OAM IP>:30205/o2ims_infrastructureInventory/v1/resourceTypes' \
+           "http://${OAM_IP}:30205/o2ims_infrastructureInventory/v1/resourceTypes" \

            -H 'accept: application/json'
 
    -  Resource
            -H 'accept: application/json'
 
    -  Resource


@@ -60,15 +69,16 @@ SMO.
       .. code:: shell
 
          curl -X 'GET' \
       .. code:: shell
 
          curl -X 'GET' \

-           "http://<OAM IP>:30205/o2ims_infrastructureInventory/v1/resourcePools/${resourcePoolId}/resources" \
+           "http://${OAM_IP}:30205/o2ims_infrastructureInventory/v1/resourcePools/${resourcePoolId}/resources" \

            -H 'accept: application/json'
 
            -H 'accept: application/json'
 

-      Get detail of one resource
+      Get detail of one resource, need to export one specific resource
+      id that wants to check

 
       .. code:: shell
 
          curl -X 'GET' \
 
       .. code:: shell
 
          curl -X 'GET' \

-           "http://<OAM IP>:30205/o2ims_infrastructureInventory/v1/resourcePools/${resourcePoolId}/resources/${resourceId}" \
+           "http://${OAM_IP}:30205/o2ims_infrastructureInventory/v1/resourcePools/${resourcePoolId}/resources/${resourceId}" \

            -H 'accept: application/json'
 
    -  Deployment manager services endpoint
            -H 'accept: application/json'
 
    -  Deployment manager services endpoint


@@ -79,20 +89,40 @@ SMO.
       .. code:: shell
 
          curl -X 'GET' \
       .. code:: shell
 
          curl -X 'GET' \

-           'http://<OAM IP>:30205/o2ims_infrastructureInventory/v1/deploymentManagers' \
+           "http://${OAM_IP}:30205/o2ims_infrastructureInventory/v1/deploymentManagers" \

            -H 'accept: application/json'
 
            -H 'accept: application/json'
 

--  Subscribe to the O-Cloud resource change notification
+-  Provisioning INF platform with SMO endpoint configuration
+
+   Assume you have an SMO, then configure INF platform with SMO endpoint
+   address. This provisioning of INF O2 service will make a request from
+   INF O2 service to SMO, that make SMO know the O2 service is working.
+
+   It needs SMO to have an API like
+   “*http(s)://SMO_HOST:SMO_PORT/registration*”, which can accept JSON
+   format data.
+
+   .. code:: bash
+
+      curl -X 'POST' \
+        'http://'${OAM_IP}':30205/provision/v1/smo-endpoint' \
+        -H 'accept: application/json' \
+        -H 'Content-Type: application/json' \
+        -d '{
+        "endpoint": "http://<SMO_HOST>:<SMO_PORT>/registration"
+      }'
+
+-  Subscribe to the INF platform resource change notification

 
 

-   Assume you have a SMO, and the SMO have an API can be receive
+   Assume you have an SMO, and the SMO have an API can be receive

    callback request
 
    callback request
 

-   -  Create subscription in O-Cloud IMS
+   -  Create subscription in the INF O2 IMS

 
       .. code:: bash
 
          curl -X 'POST' \
 
       .. code:: bash
 
          curl -X 'POST' \

-           'http://<OAM IP>:30205/o2ims_infrastructureInventory/v1/subscriptions' \
+           "http://${OAM_IP}:30205/o2ims_infrastructureInventory/v1/subscriptions" \

            -H 'accept: application/json' \
            -H 'Content-Type: application/json' \
            -d '{
            -H 'accept: application/json' \
            -H 'Content-Type: application/json' \
            -d '{


@@ -104,7 +134,7 @@ SMO.
    -  Handle resource change notification
 
       When the SMO callback API get the notification that the resource
    -  Handle resource change notification
 
       When the SMO callback API get the notification that the resource

-      of O-Cloud changing, use the URL to get the latest resource
+      of INF platform changing, use the URL to get the latest resource

       information to update its database
 
 -  Orchestrate CNF in helm chart
       information to update its database
 
 -  Orchestrate CNF in helm chart


@@ -115,27 +145,31 @@ SMO.
    We need to do some preparation to make the helm repo work and include
    our firewall chart inside of the repository.
 
    We need to do some preparation to make the helm repo work and include
    our firewall chart inside of the repository.
 

-      Get the DMS Id in the O-Cloud, and set it into bash environment
+      Get the DMS Id in the INF O2 service, and set it into bash environment

 
       .. code:: bash
 
 
       .. code:: bash
 

-         curl --location --request GET 'http://<OAM IP>:30205/o2ims_infrastructureInventory/v1/deploymentManagers'
+         curl --location --request GET "http://${OAM_IP}:30205/o2ims_infrastructureInventory/v1/deploymentManagers"

 
 

-         export dmsId=`curl --location --request GET 'http://<OAM IP>:30205/o2ims_infrastructureInventory/v1/deploymentManagers' 2>/dev/null | jq .[].deploymentManagerId | xargs echo`
+         export dmsId=`curl --location --request GET "http://${OAM_IP}:30205/o2ims_infrastructureInventory/v1/deploymentManagers" 2>/dev/null | jq .[].deploymentManagerId | xargs echo`

 
 

-      Using helm to deploy a chartmuseum to the INF
+         echo ${dmsId} # check the exported DMS id
+
+      Using helm to deploy a chartmuseum to the INF platform

 
       .. code:: bash
 
 
       .. code:: bash
 

+         helm repo add chartmuseum https://chartmuseum.github.io/charts
+         helm repo update

          helm pull chartmuseum/chartmuseum # download chartmuseum-3.4.0.tgz to local
          tar zxvf chartmuseum-3.4.0.tgz
          cat <<EOF>chartmuseum-override.yaml
          env:
          helm pull chartmuseum/chartmuseum # download chartmuseum-3.4.0.tgz to local
          tar zxvf chartmuseum-3.4.0.tgz
          cat <<EOF>chartmuseum-override.yaml
          env:

-          open:
-            DISABLE_API: false
+           open:
+             DISABLE_API: false

          service:
          service:

-          type: NodePort
-          nodePort: 30330
+           type: NodePort
+           nodePort: 30330

          EOF
 
          helm install chartmuseumrepo chartmuseum/chartmuseum -f chartmuseum-override.yaml
          EOF
 
          helm install chartmuseumrepo chartmuseum/chartmuseum -f chartmuseum-override.yaml


@@ -155,29 +189,44 @@ SMO.
 
          git clone https://github.com/biny993/firewall-host-netdevice.git
          tar -zcvf firewall-host-netdevice-1.0.0.tgz firewall-host-netdevice/
 
          git clone https://github.com/biny993/firewall-host-netdevice.git
          tar -zcvf firewall-host-netdevice-1.0.0.tgz firewall-host-netdevice/

-         helm push firewall-host-netdevice-1.0.0.tgz o2imsrepo
+         helm plugin install https://github.com/chartmuseum/helm-push.git
+         helm cm-push firewall-host-netdevice-1.0.0.tgz o2imsrepo

          helm repo update
          helm search repo firewall
 
          helm repo update
          helm search repo firewall
 

-   -  Create NfDeploymentDescriptor
+      Setup host net device over INF node

 
       .. code:: bash
 
 
       .. code:: bash
 

-         curl --location --request POST "http://<OAM IP>:30205/o2dms/${dmsId}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor" \
+         ssh sysadmin@<INF OAM IP>
+         sudo ip link add name veth11 type veth peer name veth12
+         sudo ip link add name veth21 type veth peer name veth22
+         sudo ip link |grep veth
+         exit
+
+   -  Create NfDeploymentDescriptor on the INF O2 DMS
+
+      .. code:: bash
+
+         curl --location --request POST "http://${OAM_IP}:30205/o2dms/${dmsId}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor" \

          --header 'Content-Type: application/json' \
          --data-raw '{
            "name": "cfwdesc1",
            "description": "demo nf deployment descriptor",
          --header 'Content-Type: application/json' \
          --data-raw '{
            "name": "cfwdesc1",
            "description": "demo nf deployment descriptor",

-           "artifactRepoUrl": "http://${NODE_IP}:30330",
+           "artifactRepoUrl": "http://'${NODE_IP}':30330",

            "artifactName": "firewall-host-netdevice",
            "inputParams": 
            "artifactName": "firewall-host-netdevice",
            "inputParams": 

-           "{\n  \"image\": {\n    \"repository\": \"ubuntu\",\n    \"tag\": 18.04,\n    \"pullPolicy\": \"IfNotPresent\"\n  },\n  \"resources\": {\n    \"cpu\": 2,\n    \"memory\": \"2Gi\",\n    \"hugepage\": \"256Mi\",\n    \"unprotectedNetPortVpg\": \"veth11\",\n    \"unprotectedNetPortVfw\": \"veth12\",\n    \"unprotectedNetCidr\": \"10.10.1.0/24\",\n    \"unprotectedNetGwIp\": \"10.10.1.1\",\n    \"protectedNetPortVfw\": \"veth21\",\n    \"protectedNetPortVsn\": \"veth22\",\n    \"protectedNetCidr\": \"10.10.2.0/24\",\n    \"protectedNetGwIp\": \"10.10.2.1\",\n    \"vfwPrivateIp0\": \"10.10.1.1\",\n    \"vfwPrivateIp1\": \"10.10.2.1\",\n    \"vpgPrivateIp0\": \"10.10.1.2\",\n    \"vsnPrivateIp0\": \"10.10.2.2\"\n  }\n}",
+           "{\n  \"image\": {\n    \"repository\": \"ubuntu\",\n    \"tag\": 18.04,\n    \"pullPolicy\": \"IfNotPresent\"\n  },\n  \"resources\": {\n    \"cpu\": 2,\n    \"memory\": \"2Gi\",\n    \"hugepage\": \"0Mi\",\n    \"unprotectedNetPortVpg\": \"veth11\",\n    \"unprotectedNetPortVfw\": \"veth12\",\n    \"unprotectedNetCidr\": \"10.10.1.0/24\",\n    \"unprotectedNetGwIp\": \"10.10.1.1\",\n    \"protectedNetPortVfw\": \"veth21\",\n    \"protectedNetPortVsn\": \"veth22\",\n    \"protectedNetCidr\": \"10.10.2.0/24\",\n    \"protectedNetGwIp\": \"10.10.2.1\",\n    \"vfwPrivateIp0\": \"10.10.1.1\",\n    \"vfwPrivateIp1\": \"10.10.2.1\",\n    \"vpgPrivateIp0\": \"10.10.1.2\",\n    \"vsnPrivateIp0\": \"10.10.2.2\"\n  }\n}",

            "outputParams": "{\"output1\": 100}"
          }'
 
            "outputParams": "{\"output1\": 100}"
          }'
 

-         curl --location --request GET "http://<OAM IP>:30205/o2dms/${dmsId}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor"
+         curl --location --request GET "http://${OAM_IP}:30205/o2dms/${dmsId}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor"
+
+         export descId=` curl -X 'GET'   "http://${OAM_IP}:30205/o2dms/${dmsId}/O2dms_DeploymentLifecycle/NfDeploymentDescriptor"   -H 'accept: application/json'   -H 'X-Fields: id' 2>/dev/null | jq .[].id | xargs echo`

 
 

-   -  Create NfDeployment
+         echo ${descId} # check the exported descriptor id
+
+   -  Create NfDeployment on the INF O2 DMS

 
       When you have an descriptor of deployment, you can create a
       NfDeployment, it will trigger an event inside of the IMS/DMS, and
 
       When you have an descriptor of deployment, you can create a
       NfDeployment, it will trigger an event inside of the IMS/DMS, and


@@ -185,16 +234,16 @@ SMO.
 
       .. code:: bash
 
 
       .. code:: bash
 

-         curl --location --request POST "http://<OAM IP>:30205/o2dms/${dmsId}/O2dms_DeploymentLifecycle/NfDeployment" \
+         curl --location --request POST "http://${OAM_IP}:30205/o2dms/${dmsId}/O2dms_DeploymentLifecycle/NfDeployment" \

          --header 'Content-Type: application/json' \
          --data-raw '{
            "name": "cfw100",
            "description": "demo nf deployment",
          --header 'Content-Type: application/json' \
          --data-raw '{
            "name": "cfw100",
            "description": "demo nf deployment",

-           "descriptorId": "<Descriptor ID>",
+           "descriptorId": "'${descId}'",

            "parentDeploymentId": ""
          }'
 
            "parentDeploymentId": ""
          }'
 

-         curl --location --request GET "http://<OAM IP>:30205/o2dms/${dmsId}/O2dms_DeploymentLifecycle/NfDeployment"
+         curl --location --request GET "http://${OAM_IP}:30205/o2dms/${dmsId}/O2dms_DeploymentLifecycle/NfDeployment"

 
    -  Check pods of the firewall sample
 
 
    -  Check pods of the firewall sample
 


@@ -206,6 +255,8 @@ SMO.
 
       .. code:: shell
 
 
       .. code:: shell
 

-         export NfDeploymentId=`curl --location --request GET 'http://<OAM IP>:30205/o2dms/${dmsId}/O2dms_DeploymentLifecycle/NfDeployment' 2>/dev/null | jq .[].id | xargs echo`
+         export NfDeploymentId=`curl --location --request GET "http://${OAM_IP}:30205/o2dms/${dmsId}/O2dms_DeploymentLifecycle/NfDeployment" 2>/dev/null | jq .[].id | xargs echo`
+
+         echo ${NfDeploymentId} # Check the exported deployment id

 
 

-         curl --location --request DELETE "http://<OAM IP>:30205/o2dms/${dmsId}/O2dms_DeploymentLifecycle/NfDeployment/${NfDeploymentId}"
+         curl --location --request DELETE "http://${OAM_IP}:30205/o2dms/${dmsId}/O2dms_DeploymentLifecycle/NfDeployment/${NfDeploymentId}"