Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

edits to reflect that we are defining two models, not one #71

Merged
merged 1 commit into from
Jun 13, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 21 additions & 21 deletions objectives.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Design Scope and Requirements {#sec-req}

## Scope of Data Model for ALTO O&M {#scope}
## Scope of Data Models for ALTO O&M {#scope}

The following items are in the scope of the data model specified in this document:
The following items are in the scope of the data models specified in this document:

- Deploying an ALTO server/client.
- Operating and managing an ALTO server/client.
Expand All @@ -20,8 +20,8 @@ implementation, including:

## Basic Requirements {#requirements}

Based on discussions and recommendations in {{RFC7285}} and {{RFC7971}}, the
data model provided by this document satisfies basic requirements listed in
Based on the discussions and recommendations in {{RFC7285}} and {{RFC7971}}, the
data models provided by this document satisfy basic requirements listed in
[](#TableReq).

| Requirement | Reference |
Expand All @@ -39,47 +39,47 @@ data model provided by this document satisfies basic requirements listed in

## Additional Requirements for Extensibility {#extra-req}

R8: As the ALTO protocol is extensible, the data model for ALTO O&M should
R8: As the ALTO protocol is extensible, the data models for ALTO O&M should
allow for augmentation to support potential future extensions.

## Overview of ALTO O&M Data Model for Reference ALTO Architecture
## Overview of ALTO O&M Data Models for Reference ALTO Architecture

[](#alto-ref-arch) shows a reference architecture for an ALTO server
implementation. It indicates the major server components that an ALTO server
usually needs to include and the YANG modules that these server components
need to implement.

The following server components need to implement `ietf-alto.yang` ([](#alto-model)):
The following server components need to implement the 'ietf-alto' module ([](#alto-model)):

Server manager:
: It provides the functionality and configuration of the server-level
: Provides the functionality and configuration of the server-level
management, including server listen stack setup, server discovery setup,
logging system configuration, global meta data, and server-level security
configuration.

Information resource manager:
: It provides the operation and management for creating, updating, and
: Provides the operation and management for creating, updating, and
removing ALTO information resources.

Data source listener:
: An ALTO server may start multiple data source listener. Each data source
listener defines a communication endpoint that can fetch the ALTO-related
: An ALTO server may start multiple data source listeners. Each data source
listener defines a communication endpoint that can fetch ALTO-related
information from data sources. The information can be either raw
network/computation information or pre-processed ALTO-level information.

The following components need to implement `ietf-alto-stats.yang`
The following components need to implement the 'ietf-alto-stats' module
([](#alto-stats-model)) to provide statistics information:

Performance monitor:
: It collects ALTO-specific performance metrics during the ALTO server is
: Collects ALTO-specific performance metrics during an ALTO server is
running.

Logging and fault manager:
: It collects runtime logs and failures generated by the ALTO server and the service
: Collects runtime logs and failure events that are generated by an ALTO server and the service
of each ALTO information resource.

The following components are also important for an ALTO server, although they
are not in the scope of the data model defined in this document:
are not in the scope of the data models defined in this document:

Data broker:
: An ALTO server may implement a data broker to store network/computation
Expand All @@ -91,7 +91,7 @@ Algorithm plugin:
: The service of each ALTO information resource needs to configure an algorithm to decide
how to calculate the ALTO responses. The algorithm plugins implement those
algorithms. User-specified YANG modules can be applied to different algorithm
plugins by augmenting the data model defined in this document
plugins by augmenting the ALTO modules
([](#alto-ext-model)).

Generally, the ALTO server components illustrated above have the following
Expand All @@ -113,29 +113,29 @@ interactions with each other:
~~~
+----------------------+ +-----------------+
| Performance Monitor: |<-----| Server Manager: |
| ietf-alto-stats.yang |<-+ +-| ietf-alto.yang |
| "ietf-alto-stats" |<-+ +-| "ietf-alto" |
+----------------------+ | | +-----------------+
report
+----------------------+ | | +-------------------+
| Logging and Fault | +---| Information |
| Manager: |<---+ | Resource Manager: |
| ietf-alto-stats.yang |<-----| ietf-alto.yang |
| "ietf-alto-stats" |<-----| "ietf-alto" |
+----------------------+ +-------------------+
^|
|| callback
|v
............. ................................
/ \ <------ . Algorithm Plugin: .
. Data Broker . read . example-vendor-alto-alg.yang .
. Data Broker . read . "example-vendor-alto-alg" .
............... ................................
^
| write
+----------------+ Data Source ++=============++
| Data Source | API || ||
| Listener: | <=====-=====> || Data Source ||
| ietf-alto.yang | || ||
| "ietf-alto" | || ||
+----------------+ ++=============++
~~~
{: #alto-ref-arch title="A Reference ALTO Server Architecture and YANG Modules"}
{: #alto-ref-arch title="A Reference ALTO Server Architecture and ALTO YANG Modules"}

<!-- End of sections -->