Configuration Interface API

Project Status:

(roll over for info)

Write

The working group is currently writing the document. This is a collaborative approach using Google Docs.

Start:

June 1, 2020

Estimated Completion:

January 1, 2022

TBD

Problem Statement

The interchange of content delivery configuration metadata between the various entities in the delivery ecosystem is essential for efficient interoperability. The need for an industry-standard API and metadata model becomes increasingly important as content and service providers automate more of their operations, and as technologies such as open caching require coordination of content delivery configurations. A single, unifying method to manage configurations across all delivery providers can not only mitigate potential errors but also reduce the required time to deploy configurations to multiple networks.

Project Description

The project has focused on gathering and analyzing use cases and requirements from each of the types of participants in CDN and Open Caching Configuration Management. This covers the perspectives of Content Providers, CDNs, ISPs, and Open Caching technology providers. The effort has focused on extending the IETF CDNi metadata model to cover real-world use cases in the CDN and Open Caching ecosystem, as well as defining a simple API  for basic configuration publishing and an advanced API that addresses the full life cycle of CDN configuration management (versioning, promotion across environments, configuration sharing, etc…).

Project Type

Code and Document

Project Leads

Project leads have not yet been identified.

Advisors

There are no SMEs associated with this project.

Published Documents

Open Caching Configuration Interface: Part 1

This is the first part in a set of documents that specifies the motivational drivers, use cases, and standards for a configuration interface to facilitate interoperability within the content delivery network (CDN) and open caching ecosystems. This document set presents a layered architecture that extends the Internet Engineering Task Force (IETF) CDN Interconnect (CDNi) metadata model and adds publishing layer Application Programming Interfaces (APIs) to provide configuration management capabilities required by the CDN and open caching industries.


Version: 1

Date Plublished: 02/03/2022

Open Caching Configuration Interface: Part 2 – Extensions to the CDNi Metadata Object Model

This is part two in a set of documents that specifies the motivational drivers, use cases, and standards for a configuration interface to facilitate interoperability within the content delivery network (CDN) and open caching ecosystem. This document presents the context and requirements for extending the Content Delivery Network Interconnection (CDNi) metadata model, as well as specific extensions that will fulfill those requirements. This document will provide all the necessary information for an Internet Engineering Task Force (IETF) memo describing the Streaming Video Alliance (SVA) metadata interface requirements beyond those stated in RFC-7337 (Content Distribution Network Interconnection Requirements), along with requested extensions to RFC-8006 (Content Delivery Network Interconnection Metadata).


Version: 1.0

Date Plublished: 02/03/2022

Open Caching Configuration Interface: Part 3 – Publishing Layer APIs

This is part three in a set of documents that specifies the motivations, use cases, and standards for a configuration interface to facilitate interoperability within the content delivery network (CDN) and open caching ecosystems. In this document, the requirements for a configuration publishing layer are presented, along with APIs that facilitate the publishing of CDNi metadata objects within the CDN and open caching ecosystems.


Version:

Date Plublished:

Goals and Objectives

This project has the following goals and objectives:
  • To define an API specification that provides for the deployment and management of cache configurations across multiple CDN providers and Open Caching Nodes.

Project Scope

The API specification produced by this project will PROVIDE:
  • A list of supported cache configuration features
  • Description of a programmatic method by which to deploy configurations to different caching systems
  • Programmatic methods for error detection and error correction in configuration deployment
  • A data structure and recommended container for configuration representation
The API specification will NOT PROVIDE:
  • Any specific programming languages that should be used to extract metrics
  • Any support for configuration features not specifically listed and addressed by methods within the API

Contributors

The following members have contributed to this project. Click on their name to visit their profile. If they have not published their profile, the link will redirect to their LinkedIn profile.

Additional References

There are no additional references or other required readings need to participate in this project.

Scroll to Top