fixed typos in index.rst
[optf/has.git] / docs / index.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 Optimization Framework: Homing and Allocation
4 =============================================
5
6 OOF-HAS is an policy-driven placement optimizing service (or homing service) that allows ONAP to 
7 deploy services automatically across multiple sites and multiple clouds. 
8 It enables placement based on a wide variety of policy constraints including capacity, 
9 location, platform capabilities, and other service specific constraints. 
10
11 HAS is a distributed resource broker that enables automated policy-driven optimized placement of 
12 services on a global heterogeneous platform using ONAP. Given a set of service components 
13 (based on SO decomposition flows) and requirements for placing these components 
14 (driven by policies), HAS finds optimal resources (cloud regions or existing service instances) 
15 to home these service components such that it meets all the service requirements. 
16 HAS is architected as an extensible homing service that can accommodate a growing set of 
17 homing objectives, policy constraints, data sources and placement algorithms. It is also 
18 service-agnostic by design and can easily onboard new services with minimal effort. 
19 Therefore, HAS naturally extends to a general policy-driven optimizing placement platform 
20 for wider range of services, e.g., DCAE micro-services, ECOMP control loops, server capacity, etc. 
21 Finally, HAS provides an traceable mechanism for what-if analysis which is critical for ease of 
22 understanding a homing recommendation and resolving infeasibility scenarios.
23
24 .. toctree::
25    :maxdepth: 1
26
27    ./sections/architecture.rst
28    ./sections/homingspecification.rst
29    ./sections/offeredapis.rst
30    ./sections/consumedapis.rst
31    ./sections/delivery.rst
32    ./sections/logging.rst
33    ./sections/installation.rst
34    ./sections/configuration.rst
35    ./sections/administration.rst
36    ./sections/humaninterfaces.rst
37    ./sections/release-notes.rst
38