summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 61a3af4b149547f8273ad06bba5d59106ce79bac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<!--
  ============LICENSE_START=======================================================
   Copyright (C) 2021 Nordix Foundation.
  ================================================================================
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  SPDX-License-Identifier: Apache-2.0
  ============LICENSE_END=========================================================
-->

# Configuration Persistence Service

## General Information
* [CPS Project Wiki](https://wiki.onap.org/display/DW/Configuration+Persistence+Service+Project)

## For Developers
* [Developer Wiki](https://wiki.onap.org/display/DW/Configuration+Persistence+Service+Developer%27s+Landing+Page)
* [Building and running CPS locally](docker-compose/README.md)
1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */ }
# ONAP on Vagrant

This vagrant project pretends to collect information about a way to deploy
and build [ONAP project](https://www.onap.org/) into a development environment.

### Problem Being Solved

* Reduce the barrier of entry to allow new ONAP developers to ramp up on to
active development quickly
* Reduce the cost to the community in responding to simple environment setup
questions faced by new developers

---

| Component        | Requirement                           |
|------------------|---------------------------------------|
| Vagrant          | >= 1.8.6                              |
| Provider         | VirtualBox, Libvirt or OpenStack      |
| Operating System | Linux, Mac OS or Windows              |
| Hard Disk        | > 8 GB of free disk                   |
| Memory           | > 12 GB                               |

---

## Execution:

#### deploying a single application

* Windows

    PS C:\> cd integration\bootstrap\vagrant-onap
    PS C:\integration\bootstrap\vagrant-onap> Set-ExecutionPolicy Bypass -Scope CurrentUser
    PS C:\integration\bootstrap\vagrant-onap> .\tools\Run.ps1 <app_name>

* Linux or Mac OS

    $ cd integration/bootstrap/vagrant-onap
    $ ./tools/run.sh <app_name>

current options include:

| app_name   | description                         |
|:----------:|-------------------------------------|
| aai        | Active and Available Inventory      |
| appc       | Application Controller              |
| ccsdk      | Common Controller SDK               |
| dcae       | Data Collection Analytics & Events  |
| mr         | Message Router                      |
| mso        | Master Service Orchestrator         |
| msb        | Microservices Bus Project           |
| multicloud | Multi Cloud                         |
| oom        | ONAP Operations Manager             |
| policy     | Policy                              |
| portal     | Portal                              |
| robot      | Robot                               |
| sdc        | Service Design & Creation           |
| sdnc       | Software Defined Network Controller |
| vfc        | Virtual Function Controller         |
| vid        | Virtual Infrastructure Development  |
| vnfsdk     | VNF SDK                             |
| vvp        | VNF Validation Program              |

| app_name   | description                              |
|:----------:|------------------------------------------|
| all_in_one | All ONAP services in a VM (experimental) |
| testing    | Unit Test VM                             |

| app_name   | description          |
|:----------:|----------------------|
| openstack  | OpenStack Deployment |

#### Generating documentation

The documentation of this project was written in reStructuredText
format which is located under the [docs folder](../blob/master/doc/source/index.rst).
It's possible to format these documents to HTML using Sphinix python
tool.

    $ tox -e docs

This results in the creation of a new *doc/build/html* folder with
the documentation converted in HTML pages that can be viewed through
the preferred Web Browser.

## Contributing

Bug reports and patches are most welcome.
See the [contribution guidelines](CONTRIBUTING.md).

## License

Apache-2.0