diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/oom_developer_guide.rst | 42 | ||||
| -rw-r--r-- | docs/oom_quickstart_guide.rst | 4 | ||||
| -rw-r--r-- | docs/oom_setup_kubernetes_rancher.rst | 22 | ||||
| -rw-r--r-- | docs/oom_user_guide.rst | 38 | ||||
| -rw-r--r-- | docs/release-notes.rst | 84 |
5 files changed, 120 insertions, 70 deletions
diff --git a/docs/oom_developer_guide.rst b/docs/oom_developer_guide.rst index 70e2a7253a..a2ccc1ba60 100644 --- a/docs/oom_developer_guide.rst +++ b/docs/oom_developer_guide.rst @@ -127,8 +127,9 @@ deployment by using the `-f` Helm option as follows:: > helm install local/onap -name development -f dev.yaml Note that there are one or more example deployment files in the -`onap/resources/environments/` directory. It is best practice to create a unique -deployment file for each environment used to ensure consistent behaviour. +`onap/resources/environments/` directory. It is best practice to create a +unique deployment file for each environment used to ensure consistent +behaviour. To aid in the long term supportability of ONAP, a set of common charts have been created (and will be expanded in subsequent releases of ONAP) that can be @@ -185,11 +186,11 @@ used by any of the ONAP components by including the common component in its The common section of charts consists of a set of templates that assist with parameter substitution (`_name.tpl` and `_namespace.tpl`) and a set of charts -for components used throughout ONAP. Initially `mysql` is in the common area but -this will expand to include other databases like `mariadb-galera`, `postgres`, -and `cassandra`. Other candidates for common components include `redis` and -`kafka`. When the common components are used by other charts they are -instantiated each time. In subsequent ONAP releases some of the common +for components used throughout ONAP. Initially `mysql` is in the common area +but this will expand to include other databases like `mariadb-galera`, +`postgres`, and `cassandra`. Other candidates for common components include +`redis` and`kafka`. When the common components are used by other charts they +are instantiated each time. In subsequent ONAP releases some of the common components could be a setup as services that are used by multiple ONAP components thus minimizing the deployment and operational costs. @@ -239,8 +240,8 @@ configuration files stored in the `config` directory. It is the responsibility of each ONAP component team to update these configuration files when changes are made to the project containers that impact configuration. -The following section describes how the hierarchical ONAP configuration system is -key to management of such a large system. +The following section describes how the hierarchical ONAP configuration system +is key to management of such a large system. Configuration Management ======================== @@ -461,7 +462,8 @@ describe the configuration and desired state of the ONAP components. Name Spaces ----------- -Within the namespaces are Kubernetes services that provide external connectivity to pods that host Docker containers. +Within the namespaces are Kubernetes services that provide external +connectivity to pods that host Docker containers. ONAP Components to Kubernetes Object Relationships -------------------------------------------------- @@ -639,7 +641,8 @@ OOM Networking with Kubernetes ------------------------------ - DNS -- Ports - Flattening the containers also expose port conflicts between the containers which need to be resolved. +- Ports - Flattening the containers also expose port conflicts between the + containers which need to be resolved. Node Ports ~~~~~~~~~~ @@ -937,14 +940,15 @@ More details can be found here `MSB installation <http://onap.readthedocs.io/en/ .. MISC .. ==== .. Note that although OOM uses Kubernetes facilities to minimize the effort -.. required of the ONAP component owners to implement a successful rolling upgrade -.. strategy there are other considerations that must be taken into consideration. +.. required of the ONAP component owners to implement a successful rolling +.. upgrade strategy there are other considerations that must be taken into +.. consideration. .. For example, external APIs - both internal and external to ONAP - should be -.. designed to gracefully accept transactions from a peer at a different software -.. version to avoid deadlock situations. Embedded version codes in messages may -.. facilitate such capabilities. +.. designed to gracefully accept transactions from a peer at a different +.. software version to avoid deadlock situations. Embedded version codes in +.. messages may facilitate such capabilities. .. -.. Within each of the projects a new configuration repository contains all of the -.. project specific configuration artifacts. As changes are made within the -.. project, it's the responsibility of the project team to make appropriate +.. Within each of the projects a new configuration repository contains all of +.. the project specific configuration artifacts. As changes are made within +.. the project, it's the responsibility of the project team to make appropriate .. changes to the configuration data. diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index 0029d5fb9a..a965603efd 100644 --- a/docs/oom_quickstart_guide.rst +++ b/docs/oom_quickstart_guide.rst @@ -20,7 +20,8 @@ available), follow the following instructions to deploy ONAP. > cd oom/kubernetes **Step 2.** Install Helm Plugins required to deploy the ONAP Casablanca release:: - sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm + + > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm **Step 3.** Customize the onap/values.yaml file to suit your deployment. You may want to selectively enable or disable ONAP components by changing the @@ -74,6 +75,7 @@ Use the following to monitor your deployment and determine when ONAP is ready fo > kubectl get pods --all-namespaces -o=wide Undeploying onap can be done using the following command:: + > helm undeploy dev --purge diff --git a/docs/oom_setup_kubernetes_rancher.rst b/docs/oom_setup_kubernetes_rancher.rst index 35ab88eb06..5159377386 100644 --- a/docs/oom_setup_kubernetes_rancher.rst +++ b/docs/oom_setup_kubernetes_rancher.rst @@ -72,7 +72,8 @@ new one to assign. Apply customization script for the Rancher VM --------------------------------------------- -Click :download:`openstack-rancher.sh <openstack-rancher.sh>` to download the script. +Click :download:`openstack-rancher.sh <openstack-rancher.sh>` to download the +script. .. literalinclude:: openstack-rancher.sh :language: bash @@ -134,8 +135,9 @@ The size of a Kubernetes host depends on the size of the ONAP deployment that will be installed. As of the Casablanca release a minimum 224GB will be needed to run a -full ONAP deployment (all components). It is recommended that more hosts are used -with fewer resources instead of only a few large hosts. For example 14 x 16GB hosts. +full ONAP deployment (all components). It is recommended that more hosts are +used with fewer resources instead of only a few large hosts. For example 14 x +16GB hosts. If a small subset of ONAP components are being deployed for testing purposes, then a single 16GB or 32GB host should suffice. @@ -216,7 +218,8 @@ node plays the role of NFS Master (indicated by the crown symbol). To properly set up an NFS share on Master and Slave nodes, the user can run the scripts below. -Click :download:`master_nfs_node.sh <master_nfs_node.sh>` to download the script. +Click :download:`master_nfs_node.sh <master_nfs_node.sh>` to download the +script. .. literalinclude:: master_nfs_node.sh :language: bash @@ -264,7 +267,8 @@ Add Kubernetes Environment to Rancher .. image:: Click_create.jpeg -6. Select the new named environment (ie. SB4) from the dropdown list (top left). +6. Select the new named environment (ie. SB4) from the dropdown list (top + left). Rancher is now waiting for a Kubernetes Host to be added. @@ -273,7 +277,8 @@ Rancher is now waiting for a Kubernetes Host to be added. Add Kubernetes Host ------------------- -1. If this is the first (or only) host being added - click on the "Add a host" link +1. If this is the first (or only) host being added - click on the "Add a host" + link .. image:: K8s-Assign_Floating_IP_for_external_access.jpeg @@ -285,7 +290,8 @@ otherwise select INFRASTRUCTURE→ Hosts and click on "Add Host" .. image:: otherwise_select_INFRASTRUCTURE_Hosts_and_click_on_Add_Host.jpg -2. Enter the management IP for the k8s VM (e.g. 10.0.0.4) that was just created. +2. Enter the management IP for the k8s VM (e.g. 10.0.0.4) that was just + created. 3. Click on “Copy to Clipboard” button @@ -469,5 +475,3 @@ documentation to get started: - :ref:`quick-start-label` - deploy ONAP on an existing cloud - :ref:`user-guide-label` - a guide for operators of an ONAP instance - - diff --git a/docs/oom_user_guide.rst b/docs/oom_user_guide.rst index 99a9a474d1..f19924dd17 100644 --- a/docs/oom_user_guide.rst +++ b/docs/oom_user_guide.rst @@ -52,18 +52,22 @@ ONAP with a few simple commands. Pre-requisites -------------- -Your environment must have both the Kubernetes `kubectl` and Helm setup as a one time activity. +Your environment must have both the Kubernetes `kubectl` and Helm setup as a +one time activity. Install Kubectl ~~~~~~~~~~~~~~~ -Enter the following to install kubectl (on Ubuntu, there are slight differences on other O/Ss), the Kubernetes command line interface used to manage a Kubernetes cluster:: +Enter the following to install kubectl (on Ubuntu, there are slight differences +on other O/Ss), the Kubernetes command line interface used to manage a +Kubernetes cluster:: > curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.8.10/bin/linux/amd64/kubectl > chmod +x ./kubectl > sudo mv ./kubectl /usr/local/bin/kubectl > mkdir ~/.kube -Paste kubectl config from Rancher (see the :ref:`cloud-setup-guide-label` for alternative Kubernetes environment setups) into the `~/.kube/config` file. +Paste kubectl config from Rancher (see the :ref:`cloud-setup-guide-label` for +alternative Kubernetes environment setups) into the `~/.kube/config` file. Verify that the Kubernetes config is correct:: @@ -73,7 +77,8 @@ At this point you should see six Kubernetes pods running. Install Helm ~~~~~~~~~~~~ -Helm is used by OOM for package and configuration management. To install Helm, enter the following:: +Helm is used by OOM for package and configuration management. To install Helm, +enter the following:: > wget http://storage.googleapis.com/kubernetes-helm/helm-v2.9.1-linux-amd64.tar.gz > tar -zxvf helm-v2.9.1-linux-amd64.tar.gz @@ -89,7 +94,8 @@ Install the Helm Tiller application and initialize with:: Install the Helm Repo --------------------- -Once kubectl and Helm are setup, one needs to setup a local Helm server to server up the ONAP charts:: +Once kubectl and Helm are setup, one needs to setup a local Helm server to +server up the ONAP charts:: > helm install osn/onap @@ -117,7 +123,8 @@ To setup a local Helm server to server up the ONAP charts:: > helm init > helm serve & -Note the port number that is listed and use it in the Helm repo add as follows:: +Note the port number that is listed and use it in the Helm repo add as +follows:: > helm repo add local http://127.0.0.1:8879 @@ -149,7 +156,8 @@ Next, install Helm Plugins required to deploy the ONAP Casablanca release:: > cp -R helm/plugins/ ~/.helm -Once the repo is setup, installation of ONAP can be done with a single command:: +Once the repo is setup, installation of ONAP can be done with a single +command:: > helm deploy development local/onap --namespace onap @@ -361,8 +369,8 @@ blocks access to the ONAP Portal. To enable direct access to this Portal from a user's own environment (a laptop etc.) the portal application's port 8989 is exposed through a `Kubernetes LoadBalancer`_ object. -Typically, to be able to access the Kubernetes nodes publicly a public address is -assigned. In Openstack this is a floating IP address. +Typically, to be able to access the Kubernetes nodes publicly a public address +is assigned. In Openstack this is a floating IP address. When the `portal-app` chart is deployed a Kubernetes service is created that instantiates a load balancer. The LB chooses the private interface of one of @@ -408,10 +416,10 @@ https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm of the page .. note:: - Besides the ONAP Portal the Components can deliver additional user interfaces, + Besides the ONAP Portal the Components can deliver additional user interfaces, please check the Component specific documentation. -.. note:: +.. note:: | Alternatives Considered: @@ -451,7 +459,8 @@ to monitor the real-time health of an ONAP deployment: - a set of liveness probes which feed into the Kubernetes manager which are described in the Heal section. -Within ONAP, Consul is the monitoring system of choice and deployed by OOM in two parts: +Within ONAP, Consul is the monitoring system of choice and deployed by OOM in +two parts: - a three-way, centralized Consul server cluster is deployed as a highly available monitor of all of the ONAP components, and @@ -693,7 +702,8 @@ example:: > helm undeploy casablanca --dry-run -will display the outcome of deleting the 'casablanca' release from the deployment. +will display the outcome of deleting the 'casablanca' release from the +deployment. To completely delete a release and remove it from the internal store enter:: > helm undeploy casablanca --purge @@ -706,4 +716,4 @@ deployment enter:: will remove `so` as the configuration indicates it's no longer part of the deployment. This might be useful if a one wanted to replace just `so` by -installing a custom version. +installing a custom version. diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 3e8a1be1b7..82e4fb1c2f 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,6 +1,8 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 Bell Canada & Amdocs Intellectual Property. All rights reserved. +.. Copyright 2017 Bell Canada & Amdocs Intellectual Property. All rights +.. reserved. .. Links .. _release-notes-label: @@ -16,39 +18,57 @@ Version 3.0.0 Casablanca Release Summary ======= -The focus of this release was on incremental improvements in the following areas: -* Pluggable persistent storage with support for GlusterFS as the first storage class provisioner -* CPU and Memory limits in Helm Charts to improve Pod placement based on resource availablity in Kubernetes Cluster +The focus of this release was on incremental improvements in the following +areas: + +* Pluggable persistent storage with support for GlusterFS as the first storage + class provisioner + +* CPU and Memory limits in Helm Charts to improve Pod placement based on + resource availablity in Kubernetes Cluster + * Support of Node Selectors for Pod placement + * Common "shared" Helm Charts referencing common images + - mariadb-galera - postgres - cassandra - mysql - mongo + * Integration of ARK Backup and Restore solution -* Introduction of Helm deploy and undeploy plugins to better manage ONAP deployments + +* Introduction of Helm deploy and undeploy plugins to better manage ONAP + deployments **Security Notes** -OOM code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. +OOM code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. Quick Links: - - `OOM project page <https://wiki.onap.org/display/DW/ONAP+Operations+Manager+Project>`_ - - `Passing Badge information for OOM <https://bestpractices.coreinfrastructure.org/en/projects/1631>`_ + - `OOM project page <https://wiki.onap.org/display/DW/ONAP+Operations+Manager+Project>`_ + + - `Passing Badge information for OOM <https://bestpractices.coreinfrastructure.org/en/projects/1631>`_ **Known Issues** -Problem: kubectl connections to pods (kubectl exec|logs) will fail after a while due to a known bug in Kubernetes (1.11.2) -Workaround: Restart of the kubelet daemons on the k8s hosts -Fix: Will be delivered in the next release via a new Kubernetes version (1.12) -- `K8S Bug Report <https://github.com/kubernetes/kubernetes/issues/67659>`_ -- `OOM-1532 <https://jira.onap.org/browse/OOM-1532>`_ -- `OOM-1516 <https://jira.onap.org/browse/OOM-1516>`_ -- `OOM-1520 <https://jira.onap.org/browse/OOM-1520>`_ + * **Problem**: kubectl connections to pods (kubectl exec|logs) will + fail after a while due to a known bug in Kubernetes (1.11.2) + + **Workaround**: Restart of the kubelet daemons on the k8s hosts + + **Fix**: Will be delivered in the next release via a new + Kubernetes version (1.12) + + - `K8S Bug Report <https://github.com/kubernetes/kubernetes/issues/67659>`_ + - `OOM-1532 <https://jira.onap.org/browse/OOM-1532>`_ + - `OOM-1516 <https://jira.onap.org/browse/OOM-1516>`_ + - `OOM-1520 <https://jira.onap.org/browse/OOM-1520>`_ Version 2.0.0 Beijing Release @@ -450,12 +470,13 @@ Sub-task **Security Notes** -OOM code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. +OOM code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. Quick Links: - - `OOM project page <https://wiki.onap.org/display/DW/ONAP+Operations+Manager+Project>`_ + - `OOM project page <https://wiki.onap.org/display/DW/ONAP+Operations+Manager+Project>`_ - - `Passing Badge information for OOM <https://bestpractices.coreinfrastructure.org/en/projects/1631>`_ + - `Passing Badge information for OOM <https://bestpractices.coreinfrastructure.org/en/projects/1631>`_ Version: 1.1.0 -------------- @@ -464,34 +485,43 @@ Version: 1.1.0 **New Features** -The Amsterdam release is the first release of the ONAP Operations Manager (OOM). +The Amsterdam release is the first release of the ONAP Operations Manager +(OOM). The main goal of the Amsterdam release was to: - - Support Flexible Platform Deployment via Kubernetes of fully containerized ONAP components - on any type of environment. + - Support Flexible Platform Deployment via Kubernetes of fully + containerized ONAP components - on any type of environment. - Support State Management of ONAP platform components. - - Support full production ONAP deployment and any variation of component level deployment for development. + - Support full production ONAP deployment and any variation of component + level deployment for development. - Platform Operations Orchestration / Control Loop Actions. - Platform centralized logging with ELK stack. **Bug Fixes** - The full list of implemented user stories and epics is available on `JIRA <https://jira.onap.org/secure/RapidBoard.jspa?rapidView=41&view=planning.nodetail&epics=visible>`_ - This is the first release of OOM, the defects fixed in this release were raised during the course of the release. - Anything not closed is captured below under Known Issues. If you want to review the defects fixed in the Amsterdam release, refer to Jira link above. + The full list of implemented user stories and epics is available on + `JIRA <https://jira.onap.org/secure/RapidBoard.jspa?rapidView=41&view=planning.nodetail&epics=visible>`_ + This is the first release of OOM, the defects fixed in this release were + raised during the course of the release. + Anything not closed is captured below under Known Issues. If you want to + review the defects fixed in the Amsterdam release, refer to Jira link + above. **Known Issues** - `OOM-6 <https://jira.onap.org/browse/OOM-6>`_ Automated platform deployment on Docker/Kubernetes VFC, AAF, MSB minor issues. - Workaround: Manual configuration changes - however the reference vFirewall use case does not currently require these components. + Workaround: Manual configuration changes - however the reference + vFirewall use case does not currently require these components. - `OOM-10 <https://jira.onap.org/browse/OOM-10>`_ Platform configuration management. OOM ONAP Configuration Management - Handling of Secrets. - Workaround: Automated workaround to be able to pull from protected docker repositories. + Workaround: Automated workaround to be able to pull from protected + docker repositories. **Security Issues** |