summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/designtime.rst20
-rw-r--r--docs/index.rst5
-rw-r--r--docs/installation.rst59
-rw-r--r--docs/userguide.rst13
4 files changed, 40 insertions, 57 deletions
diff --git a/docs/designtime.rst b/docs/designtime.rst
index 20a03efbc..68da0a1f6 100644
--- a/docs/designtime.rst
+++ b/docs/designtime.rst
@@ -5,29 +5,27 @@
Design Time User Guide
======================
-Bellow are the requirements to enable automation for a service within ONAP.
+Below are the requirements to enable automation for a service within ONAP.
For instantiation, the goal is to be able to automatically resolve all the HEAT/Helm variables, called cloud parameters.
For post-instantiation, the goal is to configure the VNF with initial configuration.
Prerequisite
-============
+------------
* Gather the cloud parameters:
instantiation:
+~~~~~~~~~~~~~~
-Have the HEAT template along with the HEAT environment file.
-
-or
-
-Have the Helm chart along with the Values.yaml file
+Have the HEAT template along with the HEAT environment file (or) Have the Helm chart along with the Values.yaml file
(CDS supports, but whether SO → Multicloud support for Helm/K8S is different story)
Post-instantiation:
+~~~~~~~~~~~~~~~~~~~
Have the configuration template to apply on the VNF.
@@ -35,9 +33,8 @@ Have the configuration template to apply on the VNF.
* JSON / XML for RESTCONF
* not supported yet - CLI
* JSON for Ansible [not supported yet]
-
-*Identify which template parameters are static and dynamic
-*Create and fill-in the a table for all the dynamic values
+* Identify which template parameters are static and dynamic
+* Create and fill-in the a table for all the dynamic values
While doing so, identify the resources using the same process to be resolved; for instance, if two IPs has to be resolved through the same IPAM, the process the resolve the IP is the same.
@@ -51,6 +48,3 @@ Services:
CBA/index
datadictionary/index
resourceassignment
- component
- template
- resquirement
diff --git a/docs/index.rst b/docs/index.rst
index 183bbbf9f..0e43fd51c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -96,14 +96,12 @@ Library
~~~~~~~
* NetconfClient
-~~~~~~~~~~~~~~~
In order to facilitate NETCONF interaction within scripts, a python NetconfClient binded to our Kotlin implementation is made available. This NetconfClient can be used when using the component-netconf-executor.
The client can be find here: https://github.com/onap/ccsdk-cds/blob/master/components/scripts/python/ccsdk_netconf/netconfclient.py
* ResolutionHelper
-~~~~~~~~~~~~~~~~~~
When executing a component executor script, designer might want to perform
resource resolution along with template meshing directly from the script
@@ -126,7 +124,8 @@ User Guide
.. toctree::
:maxdepth: 1
- userguide
+ installation
+ designtime
Controller Design Studio Presentation
diff --git a/docs/installation.rst b/docs/installation.rst
index ac72b425f..2f9ce48e7 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -3,19 +3,19 @@
.. Copyright (C) 2019 IBM.
Installation
-============
+------------
ONAP is meant to be deployed within a Kubernetes environment. Hence, the de-facto way to deploy CDS is through Kubernetes.
ONAP also package Kubernetes manifest as Chart, using Helm.
Prerequisite
-============
+------------
https://docs.onap.org/en/latest/guides/onap-developer/settingup/index.html
Setup local Helm
-================
+----------------
helm repo
@@ -23,7 +23,7 @@ helm repo
* helm repo add local http://127.0.0.1:8879
Get the chart
-=============
+-------------
Make sure to checkout the release to use, by replacing $release-tag in bellow command
@@ -33,31 +33,34 @@ cd oom/kubernetes
make cds
Install CDS
-===========
+-----------
helm install --name cds cds
Result
-======
-
-$ kubectl get all --selector=release=cds
-NAME READY STATUS RESTARTS AGE
-pod/cds-blueprints-processor-54f758d69f-p98c2 0/1 Running 1 2m
-pod/cds-cds-6bd674dc77-4gtdf 1/1 Running 0 2m
-pod/cds-cds-db-0 1/1 Running 0 2m
-pod/cds-controller-blueprints-545bbf98cf-zwjfc 1/1 Running 0 2m
-NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
-service/blueprints-processor ClusterIP 10.43.139.9 <none> 8080/TCP,9111/TCP 2m
-service/cds NodePort 10.43.254.69 <none> 3000:30397/TCP 2m
-service/cds-db ClusterIP None <none> 3306/TCP 2m
-service/controller-blueprints ClusterIP 10.43.207.152 <none> 8080/TCP 2m
-NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
-deployment.apps/cds-blueprints-processor 1 1 1 0 2m
-deployment.apps/cds-cds 1 1 1 1 2m
-deployment.apps/cds-controller-blueprints 1 1 1 1 2m
-NAME DESIRED CURRENT READY AGE
-replicaset.apps/cds-blueprints-processor-54f758d69f 1 1 0 2m
-replicaset.apps/cds-cds-6bd674dc77 1 1 1 2m
-replicaset.apps/cds-controller-blueprints-545bbf98cf 1 1 1 2m
-NAME DESIRED CURRENT AGE
-statefulset.apps/cds-cds-db 1 1 2m \ No newline at end of file
+------
+
+.. code-block:: json
+ :linenos:
+
+ $ kubectl get all --selector=release=cds
+ NAME READY STATUS RESTARTS AGE
+ pod/cds-blueprints-processor-54f758d69f-p98c2 0/1 Running 1 2m
+ pod/cds-cds-6bd674dc77-4gtdf 1/1 Running 0 2m
+ pod/cds-cds-db-0 1/1 Running 0 2m
+ pod/cds-controller-blueprints-545bbf98cf-zwjfc 1/1 Running 0 2m
+ NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
+ service/blueprints-processor ClusterIP 10.43.139.9 <none> 8080/TCP,9111/TCP 2m
+ service/cds NodePort 10.43.254.69 <none> 3000:30397/TCP 2m
+ service/cds-db ClusterIP None <none> 3306/TCP 2m
+ service/controller-blueprints ClusterIP 10.43.207.152 <none> 8080/TCP 2m
+ NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
+ deployment.apps/cds-blueprints-processor 1 1 1 0 2m
+ deployment.apps/cds-cds 1 1 1 1 2m
+ deployment.apps/cds-controller-blueprints 1 1 1 1 2m
+ NAME DESIRED CURRENT READY AGE
+ replicaset.apps/cds-blueprints-processor-54f758d69f 1 1 0 2m
+ replicaset.apps/cds-cds-6bd674dc77 1 1 1 2m
+ replicaset.apps/cds-controller-blueprints-545bbf98cf 1 1 1 2m
+ NAME DESIRED CURRENT AGE
+ statefulset.apps/cds-cds-db 1 1 2m \ No newline at end of file
diff --git a/docs/userguide.rst b/docs/userguide.rst
deleted file mode 100644
index fcc1b8882..000000000
--- a/docs/userguide.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2019 IBM.
-
-User guide
-----------
-
-.. toctree::
- :maxdepth: 1
-
- installation
- designtime
-