CDNI Cache Control Metadata
draft-ietf-cdni-cache-control-metadata-01
| Document | Type | Active Internet-Draft (cdni WG) | |
|---|---|---|---|
| Authors | Will Power , Glenn Goldstein | ||
| Last updated | 2024-03-04 | ||
| Replaces | draft-power-cdni-cache-control-metadata | ||
| RFC stream | Internet Engineering Task Force (IETF) | ||
| Intended RFC status | (None) | ||
| Formats | |||
| Additional resources | Mailing list discussion | ||
| Stream | WG state | WG Document | |
| Document shepherd | (None) | ||
| IESG | IESG state | I-D Exists | |
| Consensus boilerplate | Unknown | ||
| Telechat date | (None) | ||
| Responsible AD | (None) | ||
| Send notices to | (None) |
draft-ietf-cdni-cache-control-metadata-01
Content Delivery Networks Interconnection W. Power
Internet-Draft G. Goldstein
Intended status: Standards Track Lumen Technologies
Expires: 5 September 2024 4 March 2024
CDNI Cache Control Metadata
draft-ietf-cdni-cache-control-metadata-01
Abstract
This specification adds to the basic cache control metadata defined
in RFC8006, providing content providers and upstream CDNs (uCDNs)
more fine-grained control over downstream CDN (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.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 5 September 2024.
Copyright Notice
Copyright (c) 2024 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
extracted from this document must include Revised BSD License text as
described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Revised BSD License.
Power & Goldstein Expires 5 September 2024 [Page 1]
Internet-Draft CDNI Cache Control Metadata March 2024
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Requirements . . . . . . . . . . . . . . . . . . . . . . . . 3
3. Metadata Model Objects . . . . . . . . . . . . . . . . . . . 3
3.1. MI.CachePolicy . . . . . . . . . . . . . . . . . . . . . 3
3.2. MI.NegativeCachePolicy . . . . . . . . . . . . . . . . . 6
3.3. MI.StaleContentCachePolicy . . . . . . . . . . . . . . . 7
3.4. MI.CacheBypassPolicy . . . . . . . . . . . . . . . . . . 9
3.5. MI.ComputedCacheKey . . . . . . . . . . . . . . . . . . . 10
4. Informative Examples . . . . . . . . . . . . . . . . . . . . 11
5. Security Considerations . . . . . . . . . . . . . . . . . . . 13
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 13
6.1. CDNI Payload Types . . . . . . . . . . . . . . . . . . . 13
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 14
8. Normative References . . . . . . . . . . . . . . . . . . . . 14
9. Informative References . . . . . . . . . . . . . . . . . . . 15
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 15
1. Introduction
In addition to the cache control parameters currently specified by
the Cache object in [RFC8006], content providers and uCDNs often need
more fine-grained control over dCDN caching, including scenarios
where it is desirable to override or adjust cache control headers
from the origin.
The following capabilities are required for commercial CDN and Open
Caching use cases:
* Positive Cache Control - Allows the uCDN to specify internal
caching policies for the dCDN and external caching policies
advertised to clients of the dCDN, overriding any cache control
policy set in the response from the uCDN.
* Negative Cache Control - Allows the specification of caching
policies based on error response codes received from the origin,
allowing for fine-grained control of the downstream caching of
error responses. For example, it may be desirable to cache error
responses at the dCDN for a short period of time to prevent an
overwhelmed origin service or uCDN from being flooded with
requests.
* Cache Bypass Control - Allows content providers to bypass CDN
caching when needed (typically for testing or performance
benchmarking purposes).
Power & Goldstein Expires 5 September 2024 [Page 2]
Internet-Draft CDNI Cache Control Metadata March 2024
* Stale Content Policies - Allows control over how the dCDN should
process requests for stale content. For example, this policy
allows the content provider to specify that stale content be
served from cache for a specified time period while refreshes from
the origin occur asynchronously.
* Dynamically Constructed Cache Keys - It is typical in advanced CDN
configurations to generate cache keys that are dynamically
constructed via lightweight processing of various properties of
the Hypertext Transfer Protocol (HTTP) request and/or response.
As an example, an origin may specify a cache key as a value
returned in a specific HTTP response header. The Metadata
Expression Language (MEL) [SVTA2031] is used to allow for such
advanced cache key construction.
2. Requirements
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
3. Metadata Model Objects
3.1. MI.CachePolicy
MI.CachePolicy is a new GenericMetadata object that allows the uCDN
to specify internal caching policies for the dCDN, as well as
external caching policies expressed to clients of the dCDN
(overriding any cache control policy set in the response from the
uCDN).
The enumerated options for internal and external cache policies are
defined as follows:
* as-is: The freshness value of the object is computed at the
acquisition/validation moment within the dCDN based solely on the
uCDN origin response. This definition does not mandate any
specific implementation for the dCDN for propagating content
expiration and freshness values to the client; different dCDNs MAY
use different sets of response headers according to their type and
implementation, as long as these implementations result in
equivalent caching and expiration behaviors.
* no-cache: Indicates that the client prefers a stored response not
be used to satisfy the request without successful validation on
the origin server. See [RFC9111]
Power & Goldstein Expires 5 September 2024 [Page 3]
Internet-Draft CDNI Cache Control Metadata March 2024
* no-store: Indicates that a cache MUST NOT store any part of either
this request or any response to it. See [RFC9111]
Property: internal
* Description: Specifies the internal cache control policy that MUST
be used by the dCDN.
* Type: Either an integer in seconds (e.g., 5 for a five-second
cache) or one of these enumerated options: "as-is", or "no-cache"
or "no-store" as described above.
* Mandatory-to-Specify: No. The default is "as-is", regardless of
whether force-internal is unspecified, "True", or "False".
Property: external
* Description: Specifies the external cache control policy that MUST
be expressed to clients of the dCDN.
* Type: String. Either an integer in seconds (e.g., 5 for a five-
second cache) or one of these enumerated options: "as-is", or "no-
cache" or "no-store" as described above.
* Mandatory-to-Specify: No. The default is "as-is"", regardless of
whether force-external is unspecified, "True", or, "False ".
Property: force-internal
* Description: If set to "True", the metadata interface cache policy
defined in the MI.CachePolicy internal property value will
override any cache control policy set in the response from the
uCDN. If set to "False", the MI.CachePolicy internal property
value is only used if there is no cache control policy provided in
the response from the uCDN.
* Type: Boolean
* Mandatory-to-Specify: No. The default is "False", which will
apply the MI.CachePolicy internal property value only if no policy
is provided in the response from the uCDN.
Property: force-external
Power & Goldstein Expires 5 September 2024 [Page 4]
Internet-Draft CDNI Cache Control Metadata March 2024
* Description: If set to "True", the metadata interface cache policy
defined in the MI.CachePolicy external property value will
override any cache control policy set in the response from the
uCDN. If set to "False", the MI.CachePolicy external property
value is only used if there is no cache control policy provided in
the response from the uCDN.
* Type: Boolean
* Mandatory-to-Specify: No. The default is "False", which will
apply the MI.CachePolicy external property value only if no policy
is provided in the response from the uCDN.
When MI.CachePolicy is not specified, the dCDN will follow the uCDN
expiration and freshness response directives. In case the uCDN did
not send any such directives, the dCDN will follow its own policies.
In example 1, an MI.CachePolicy sets the internal cache control
policy to five seconds. The external cache policy is set to 'no-
cache' and both policies are forced:
{
"generic-metadata-type": "MI.CachePolicy",
"generic-metadata-value": {
"internal": 5,
"external": "no-cache",
"force-internal": true,
"force-external": true
}
}
Figure 1
In example 2, an MI.CachePolicy sets the internal cache control
policy to "as-is" (keep the policy set in the response from the
uCDN). The external cache policy is set to 'no-cache' and forced:
{
"generic-metadata-type": "MI.CachePolicy",
"generic-metadata-value": {
"internal": "as-is",
"external": "no-cache",
"force-external": true
}
}
Figure 2
Power & Goldstein Expires 5 September 2024 [Page 5]
Internet-Draft CDNI Cache Control Metadata March 2024
3.2. MI.NegativeCachePolicy
MINegativeCachePolicy is a new GenericMetadata object that allows the
specification of caching policies based on response codes received
from the origin. MINegativeCachePolicy is a simple alternative to
using the origin response processing stage [SVTA2032] with a match
criteria on specific HTTP response codes (see Informative Examples
(Section 4)), useful when a single caching policy needs to be
specified for a list of one or more response codes from the origin.
Property: error-codes
* Description: An array of HTTP response status codes (see Sections
15.5 and 15.6 of [RFC9110]) , that, if returned from the uCDN,
will be cached using the cache policy defined by the cache-policy
property.
* Type: Array of HTTP response status codes encoded as strings. Any
HTTP status code from 100 to 599, or any of the special values,
"2xx", "3xx", "4xx" or "5xx", where "xx" implies everything from
00 to 99. The use of 4xx, for example, would specify that 416
responses are cached. While repeated and redundant values in the
array are allowed, they SHOULD be avoided for efficiency (no
reason to specify both 5xx and 503, for example).
* Mandatory-to-Specify: No. The default is to revert to [RFC8006]
behavior. An empty or unspecified list MAY be used as a means to
revoke a list inherited from an upper-level configuration.
Property: cache-policy
* Description: The MI.CachePolicy to apply to the HTTP response
status codes returned by the uCDN.
* Mandatory-to-Specify: Yes
In the following example, a MI.NegativeCachePolicy object applies a
no-cache policy whenever a 403 error code or any 5xx error code are
seen from the origin.
Power & Goldstein Expires 5 September 2024 [Page 6]
Internet-Draft CDNI Cache Control Metadata March 2024
{
"generic-metadata-type": "MI.NegativeCachePolicy",
"generic-metadata-value": {
"error-codes": [ "403", "5xx" ],
"cache-policy": {
"internal": 5,
"external": "no-cache",
"force-internal": true,
"force-external": true
}
}
}
Figure 3
3.3. MI.StaleContentCachePolicy
MI.StaleContentCachePolicy is a new GenericMetadata object that
allows the uCDN to specify the policy the dCDN MUST use when
responding with stale content. For example, this policy allows the
content provider to specify that stale content MUST only be served
from cache for a specified time period while the content is
revalidated asynchronously.
Property: stale-while-revalidating
* Description: Instructs the dCDN to serve a stale version of a
resource while revalidating the resource with the uCDN. When set
to "True", the dCDN will return a previously cached version of a
resource while the resource is revalidated with the uCDN in the
background.
* Type: Boolean
* Mandatory-to-Specify: No. The default is "False", which waits for
the uCDN to revalidate a resource before responding to the client.
Property: stale-if-error
* Description: Instructs the dCDN to serve a stale version of a
resource if any one of a specified set of HTTP status codes was
received when trying to revalidate the resource with the uCDN. In
this case, the dCDN will return a previously cached version of a
resource instead of caching the error response. While this
capability is typically used for well-understood HTTP error status
codes, a list of any HTTP codes can be provided for maximum
flexibility.
Power & Goldstein Expires 5 September 2024 [Page 7]
Internet-Draft CDNI Cache Control Metadata March 2024
* Type: Array of HTTP response status codes encoded as strings.. Any
HTTP status code from 100 to 599, or any of the special values
"2xx", "3xx", "4xx" or "5xx", where "xx" implies everything from
00 to 99. While repeated and redundant values in the array are
allowed, they SHOULD be avoided for efficiency (no reason to
specify both 5xx and 503, for example).
* Mandatory-to-Specify: No. The default is to not serve stale
content. An empty or unspecified list MAY be used as a means to
revoke a list inherited from an upper-level configuration.
Property: failed-revalidation-delta-seconds
* Description: Drives the dCDN behavior when revalidation attempts
to the uCDN fail, specifying the number of seconds to wait before
making another attempt to revalidate the resource with the uCDN.
Use of failed-revalidation-delta-seconds allows load to be reduced
on the uCDN during times of system stress. Stale content is
served during this wait period.
* Type: Integer (seconds)
* Mandatory-to-Specify: No. The default is zero, which means an
attempt will be made to revalidate the resource with the uCDN
immediately.
In example 1, an MI.StaleContentCachePolicy where stale-while-
revalidating is true instructs the dCDN to respond with a stale
cached version of the resource while it revalidates the resource with
the uCDN in the background:
{
"generic-metadata-type": "MI.StaleContentCachePolicy",
"generic-metadata-value": {
"stale-while-revalidating": true
}
}
Figure 4
In example 2, an MI.StaleContentCachePolicy where stale-if-error
instructs the dCDN to use the stale cached resource if it receives an
error of type 503 or 504 when trying to revalidate the resource with
the uCDN.
Power & Goldstein Expires 5 September 2024 [Page 8]
Internet-Draft CDNI Cache Control Metadata March 2024
{
"generic-metadata-type": "MI.StaleContentCachePolicy",
"generic-metadata-value": {
"stale-if-error": [ "503", "504" ]
}
}
Figure 5
In example 3, an MI.StaleContentCachePolicy where stale-while-
revalidating is true instructs the dCDN to respond with a stale
cached version of the resource while it revalidates the resource with
the uCDN in the background.
* stale-if-error instructs the dCDN to use the stale cached resource
if it receives an error of type 404 or any 5xx status when trying
to revalidate the resource with the uCDN.
* failed-revalidation-delta-seconds instructs the dCDN to use an
additional five-second cache time-to-live (TTL) before making
another attempt to revalidate the resource from the uCDN. That
is, the dCDN will serve (the now stale) resource for another five
seconds before making another attempt to revalidate the resource
with the uCDN.
{
"generic-metadata-type": "MI.StaleContentCachePolicy",
"generic-metadata-value": {
"stale-while-revalidating": true,
"stale-if-error": [ "404", "5xx" ],
"failed-revalidation-delta-seconds": 5
}
}
Figure 6
3.4. MI.CacheBypassPolicy
MI.CacheBypassPolicy is a new GenericMetadata object that allows a
client request to be set as non-cacheable. It is expected that this
feature will be used to allow clients to bypass caching when testing
the uCDN fill path. Note: MI.CacheBypassPolicy is typically used in
conjunction with a path match or match expression on a header value
or query parameter. Any content previously cached (by client
requests that do not set MI.CacheBypassPolicy) MUST NOT be evicted.
Property: bypass-cache
Power & Goldstein Expires 5 September 2024 [Page 9]
Internet-Draft CDNI Cache Control Metadata March 2024
* Description: A Boolean value that can activate the feature for a
given client request. It is expected that this feature will be
used within ProcessingStages [SVTA2032] to allow a client request
to be marked to bypass caching (see Informative Examples
(Section 4))
* Type: Boolean
* Mandatory-to-Specify: No. The default is "False".
Example usage:
{
"generic-metadata-type": "MI.CacheBypassPolicy",
"generic-metadata-value": {
"bypass-cache": true
}
}
Figure 7
3.5. MI.ComputedCacheKey
It is typical in advanced CDN configurations to generate cache keys
that are dynamically constructed via lightweight processing of
various properties of the HTTP request and/or response. As an
example, an origin might specify a cache key as a value returned in a
specific HTTP response header.
MIComputedCacheKey is a new GenericMetadata object that allows the
specification of a cache key using the Metadata Expression Language
(MEL) defined in [SVTA2031] Typical use cases would involve
constructing a cache key from one or more elements of the HTTP
request. In cases where both the MIComputedCacheKey and the Cache
object are applied, the MIComputedCacheKey MUST take precedence.
MIComputedCacheKey is, by default, allowed within any of the
processing stages defined in [SVTA2032]. It should be noted,
however, that a dCDN MAY only allow cache keys to be altered at
certain processing stages (such as the clientRequestStage) but not at
other stages (such as the originResponse or clientResponseStage). A
dCDN MAY use FCI.MetadataExtended [SVTA2041] to advertise such
restricted usage contexts.
Property: expression
* Description: The expression that specifies how the cache key is to
be constructed.
Power & Goldstein Expires 5 September 2024 [Page 10]
Internet-Draft CDNI Cache Control Metadata March 2024
* Type: String. An expression using the Metadata Expression
Language (MEL) [SVTA2031] to dynamically construct the cache key
from elements of the HTTP request and/or response.
* Mandatory-to-Specify: Yes
In the following example, a custom request header is used as the
cache key instead of the Uniform Resource Identifier (URI) path:
{
"generic-metadata-type": "MI.ComputedCacheKey",
"generic-metadata-value": {
"expression": "req.h.X-Cache-Key"
}
}
Figure 8
4. Informative Examples
In the following example, cache policies are set in the context of
the Processing Stages Model (see the Processing Stages Metadata
Specification [SVTA2032]). If the HTTP status code received from the
origin is a 200, cache expiration is set to 300 seconds if no caching
directives were set from the uCDN (unforced). If the HTTP status
code received from the origin is a 503 or 504, the internal CDN
caching policy is forced to 5 seconds and the external downstream
policy is forced to "no-cache".
Power & Goldstein Expires 5 September 2024 [Page 11]
Internet-Draft CDNI Cache Control Metadata March 2024
{
"generic-metadata-type": "MI.OriginResponseStage",
"generic-metadata-value": {
"match-groups": [
{
"if-rule": {
"match": {
"expression": "resp.status == 200"
},
"stage-metadata": {
"generic-metadata": [
{
"generic-metadata-type": "MI.CachePolicy",
"generic-metadata-value": {
"internal": 300,
"external": 300
}
}
]
}
},
"else-if-rules": [
{
"match": {
"expression": "resp.status == 503 or resp.status == 504"
},
"stage-metadata": {
"generic-metadata": [
{
"generic-metadata-type": "MI.CachePolicy",
"generic-metadata-value": {
"internal": 5,
"external": "no-cache",
"force-internal": true,
"force-external": true
}
}
]
}
}
]
}
]
}
}
Figure 9
Power & Goldstein Expires 5 September 2024 [Page 12]
Internet-Draft CDNI Cache Control Metadata March 2024
In the next example, an MI.CacheBypassPolicy is invoked when the HTTP
request header named "cdn-bypass" is true. Processing
Stages[SVTA2032] and the Metadata Expression Language (MEL)
[SVTA2031] are used to inspect the HTTP headers as the request is
received from the client.
{
"generic-metadata-type": "MI.ProcessingStages",
"generic-metadata-value": {
"client-request": [
{
"match": {
"expression": "req.h.cdn-bypass == 'true'"
},
"stage-metadata": {
"generic-metadata": [
{
"generic-metadata-type": "MI.CacheBypassPolicy",
"generic-metadata-value": {
"bypass-cache": true
}
}
]
}
}
]
}
}
Figure 10
5. Security Considerations
The FCI and MI objects defined in the present document are
transferred via the interfaces defined in CDNI [RFC8006] which
describes how to secure these interfaces protecting integrity and
confidentiality while ensuring the authenticity of the dCDN and uCDN.
6. IANA Considerations
6.1. CDNI Payload Types
This document requests the registration of the following entries
under the "CDNI Payload Types" registry hosted by IANA:
Power & Goldstein Expires 5 September 2024 [Page 13]
Internet-Draft CDNI Cache Control Metadata March 2024
+----------------------------+---------------+
| Payload Type | Specification |
+----------------------------+---------------+
| MI.CachePolicy | RFCthis |
+----------------------------+---------------+
| MI.NegativeCachePolicy | RFCthis |
+----------------------------+---------------+
| MI.StaleContentCachePolicy | RFCthis |
+----------------------------+---------------+
| MI.CacheBypassPolicy | RFCthis |
+----------------------------+---------------+
| MI.ComputedCacheKey | RFCthis |
+----------------------------+---------------+
Table 1: CDNI Payload Types
7. Acknowledgements
The authors would like to express their gratitude to the members of
the Streaming Video Technology Alliance [SVTA] Open Caching Working
Group for their guidance / contribution / reviews ...)
Particulary the following people contribute in one or other way to
the content of this draft:
* Guillaume Bichot (Broadpeak)
* Christoph Neumann (Broadpeak)
* Pankaj Chaudhari (Disney Streaming)
* Robert Colantuoni (Disney Streaming)
* Rajeev RK (picoNETS)
* Yoav Gressel (Qwilt)
* Noam Peleg (Qwilt)
* Arnon Warshavsky (Qwilt)
* Eric Klein (Sirius XM)
* Alfonso Siloniz (Telefonica)
* Ben Rosenblum (Vecima)
8. Normative References
Power & Goldstein Expires 5 September 2024 [Page 14]
Internet-Draft CDNI Cache Control Metadata March 2024
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC8006] Niven-Jenkins, B., Murray, R., Caulfield, M., and K. Ma,
"Content Delivery Network Interconnection (CDNI)
Metadata", RFC 8006, DOI 10.17487/RFC8006, December 2016,
<https://www.rfc-editor.org/info/rfc8006>.
[RFC9110] Fielding, R., Ed., Nottingham, M., Ed., and J. Reschke,
Ed., "HTTP Semantics", STD 97, RFC 9110,
DOI 10.17487/RFC9110, June 2022,
<https://www.rfc-editor.org/info/rfc9110>.
[RFC9111] Fielding, R., Ed., Nottingham, M., Ed., and J. Reschke,
Ed., "HTTP Caching", STD 98, RFC 9111,
DOI 10.17487/RFC9111, June 2022,
<https://www.rfc-editor.org/info/rfc9111>.
[SVTA2031] SVTA, "Metadata Model Expression Language (MEL)
Specification", <https://svta.org/documents/SVTA2031>.
9. Informative References
[SVTA] SVTA, "Streaming Video Technology Alliance Home Page",
<https://www.svta.org>.
[SVTA2032] SVTA, "Processing Stages Metadata Specification",
<https://svta.org/documents/SVTA2032>.
[SVTA2041] SVTA, "Metadata Capabilities",
<https://svta.org/documents/SVTA2041>.
Authors' Addresses
Will Power
Lumen Technologies
United States of America
Email: wrpower@gmail.com
Glenn Goldstein
Lumen Technologies
United States of America
Email: glenng1215@gmail.com
Power & Goldstein Expires 5 September 2024 [Page 15]