Configuration Interface API Version 2

Project Status:

(roll over for info)

Working

The project is actively being worked on.

Start:

October 1, 2022

Estimated Completion:

December 31, 2023
  • Home
  • Configuration Interface API Version 2

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

Advisors

There are no SMEs associated with this project.

Published Documents

Version: 2.0

Date Plublished:

More Details

Add to Basket

(DRAFT) Open Caching Configuration Interface Part 3: Simple Configuration Metadata API Version 2.0

This is part 3 in a set of documents that specify the Streaming Video Alliance (SVTA) Configuration Interface. This document presents the Simple Configuration Metadata API, which provides simple metadata retrieval and publishing capabilities as introduced in part 1 of the SVTA Configuration Interface document set.

Version: 2.0

Date Plublished:

More Details

Add to Basket

(DRAFT) Open Caching Configuration Interface Part 4: Service Configuration Model Version 2.0

This specification introduces the Service Configuration Model, an object layer that wraps the Host Match metadata defined in [RFC8006] with a construct defining CDN Properties (groups of hosts with shared metadata definitions) and reusable metadata definitions that can be used across all of a service’s CDN Properties. The Service Configuration represents a self-contained bundle of configuration metadata and definitions that can be published and deployed as an atomic unit with no external references. This model is defined independently of any API, and will be used as the basis for the SVTA Orchestration API and Terraform Integration.

Version: 2.0

Date Plublished:

More Details

Add to Basket

(DRAFT) Open Caching Configuration Interface Part 5: Metadata Capabilities Version 2.0

This specification is Part 5 in the Version 2 series of the Configuration Interface documents.

Version: 2.0

Date Plublished:

More Details

Add to Basket

(DRAFT) Open Caching Configuration Interface Part 6: Orchestration API Version 2.0

This specification is Part 6 in the Version 2 series of the Configuration Interface documents.

Version: 1.1

Date Plublished: 09/28/2022

More Details

Add to Basket

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.1

Date Plublished: 09/28/2022

More Details

Add to Basket

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.1

Date Plublished: 09/28/2022

More Details

Add to Basket

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.

Draft Documents

Estimated Publication Date: Q3 2023

(DRAFT) Open Caching Configuration Interface Part 1: Overview and Architecture Version 2.0

This is the first part in a set of documents that document the Streaming Video Technology Alliance (SVTA) Configuration Interface, defining both the metadata model and APIs for entities to interchange the model. The document specifies the motivational drivers, use cases, and standards to facilitate interoperability within the content delivery network (CDN) and Open Caching ecosystems. The full document set presents a layered architecture that extends the Internet Engineering Task Force (IETF) CDN Interconnect (CDNI) metadata and capabilities models and adds publishing Application Programming Interfaces (APIs) to provide configuration management capabilities required by the CDN and open caching industries.


Estimated Publication Date: Q3 2023

(DRAFT) Open Caching Configuration Interface Part 2: CDNI Metadata Model Extensions Version 2.0

The IETF Content Delivery Networks Interconnection (CDNI) Metadata interface enables interconnected Content Delivery Networks (CDNs) to exchange content distribution metadata in order to enable content acquisition and delivery. This document and its sub-parts describe extensions to the CDNI Metadata Object Model as documented in “CDNI Metadata” [RFC8006] to address the complex requirements of the commercial CDN industry and to support a wider set of use cases such as Open Caching.


Estimated Publication Date: Q3 2023

(DRAFT) Open Caching Configuration Interface Part 2a: Metadata Expression Language (MEL) Version 2.0

This document specifies the syntax and usage examples for an expression language to be used within SVTA/CDNI Metadata Interface (MI) objects. The purpose of this expression language is to enable metadata to be applied conditionally (based on aspects of an HTTP request), and to enable HTTP responses to be generated or altered dynamically.


Estimated Publication Date: Q3 2023

(DRAFT) Open Caching Configuration Interface Part 2b: Processing Stages Metadata Version 2.0

This document specifies a set of objects extending the CDNI Metadata Model [RFC8006] to allow for metadata to be applied conditionally beyond the simple host and path matching defined in [RFC8006]. The concept of processing stages are introduced, where each stage in a CDNs processing pipeline presents an opportunity to examine requests and responses and make alterations as needed. Metadata such as caching rules can be applied conditionally (based on aspects of an HTTP request header), and HTTP responses from a source can be altered dynamically (such as adding or dropping an HTTP header). This standard leverages the expression language documented in the Metadata Expression Language (MEL) Specification.


Estimated Publication Date: Q3 2023

(DRAFT) Open Caching Configuration Interface Part 2c: Cache Control Metadata Version 2.0

This specification adds to the basic Cache Control metadata defined in [RFC8006], providing Content Providers and uCDNs more fine-grained control over dCDN caching. Use cases include overriding or adjusting cache-control headers from the origin, bypassing caching altogether, or altering cache keys with dynamically generated values.


Estimated Publication Date: Q3 2023

(DRAFT) Open Caching Configuration Interface Part 2d: Source Access Control Metadata Version 2.0

This specification provides an alternative to the SourceMetadata objects defined in [RFC8006], providing greatly extended capabilities with regards to defining multiple sources, load balancing and failover rules across those sources, and a mechanism for a CDN to monitor source health and pull unhealthy sources out of rotation. Additionally, new methods are defined for authentication access to an upstream source/origin.


Estimated Publication Date: Q3 2023

(DRAFT) Open Caching Configuration Interface Part 2e: Client Access Control Metadata Version 2.0

This specification adds to the basic client access control metadata in [RFC8006], providing Content Providers and uCDNs extended capabilities in defining location and time window restrictions. Support is also provided to define required TLS certificates and encryption levels, as well as configuration metadata for the Common Media Access Token (CAT), developed jointly by the SVTA and CTA-WAVE.


Estimated Publication Date: Q3 2023

(DRAFT) Open Caching Configuration Interface Part 2f: Edge Control Metadata Version 2.0

This specification defines configuration metadata objects related to controlling edge access to resources via CDNs and Open Caching systems. Configuring Cross-Origin Resource Sharing (CORS) access rules and the dynamic generation of CORS headers is a key feature of typical configurations, as are the ability to define response body compression rules, client connection timeouts, and traffic type hints for optimized caching.


Estimated Publication Date: Q3 2023

(DRAFT) Open Caching Configuration Interface Part 2g: Open Caching Metadata Version 2.0

This specification provides metadata defining open caching request delegation behavior for open caching node selection and request routing modes.


Estimated Publication Date: Q3 2023

(DRAFT) Open Caching Configuration Interface Part 2h: Private Features Metadata Version 2.0

This specification defines a mechanism for dCDNs to define private extensions to the metadata model that are mutually agreed upon with uCDNs and Content Providers.


Estimated Publication Date: Q3 2023

(DRAFT) Open Caching Configuration Interface Part 2i: Protected Secrets Metadata Version 2.0

This is an early draft for a proposed mechanism to protect secret values (such as keys or token salt values) that are part of the Configuration Metadata.


Estimated Publication Date: Q3 2023

(DRAFT) Open Caching Configuration Interface Part 3: Simple Configuration Metadata API Version 2.0

This is part 3 in a set of documents that specify the Streaming Video Alliance (SVTA) Configuration Interface. This document presents the Simple Configuration Metadata API, which provides simple metadata retrieval and publishing capabilities as introduced in part 1 of the SVTA Configuration Interface document set.


Estimated Publication Date: Q3 2023

(DRAFT) Open Caching Configuration Interface Part 4: Service Configuration Model Version 2.0

This specification introduces the Service Configuration Model, an object layer that wraps the Host Match metadata defined in [RFC8006] with a construct defining CDN Properties (groups of hosts with shared metadata definitions) and reusable metadata definitions that can be used across all of a service’s CDN Properties. The Service Configuration represents a self-contained bundle of configuration metadata and definitions that can be published and deployed as an atomic unit with no external references. This model is defined independently of any API, and will be used as the basis for the SVTA Orchestration API and Terraform Integration.


Estimated Publication Date: Q3 2023

(DRAFT) Open Caching Configuration Interface Part 5: Metadata Capabilities Version 2.0

This specification is Part 5 in the Version 2 series of the Configuration Interface documents.


Estimated Publication Date: Q4 2023

(DRAFT) Open Caching Configuration Interface Part 6: Orchestration API Version 2.0

This specification is Part 6 in the Version 2 series of the Configuration Interface documents.


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