Menu

Lumen help

Service-wide definitions (V2)

Important: This guide is for the V2 version of Media portal only. If you’re using V3, please refer to Configuration Management for V3, and if you are on V1.5, please note that this version has now been deprecated and we invite you to read our guide on migrating to V3.


Service-wide definitions are collections of common configuration data that can be referenced and that influence system behavior. Examples of definitions are a geo region or IP group. In and of itself, a definition does not influence how the system processes requests. Using definitions helps you avoid having to repeat common tasks across multiple match rules. You manage them in a single list allowing for a single change to propagate through all references.

Adding a Service-Wide Definition

To add a service-wide definition to the configuration, sign into Media Portal, open the Caching page by navigating to My Services > Caching, and select the access group, Service Component ID (SCID) and configuration you want to work with, then click on “Edit Configuration”.

 

  • If you’re creating a new configuration, click on “Add Configuration” instead of selecting one from the drop-down menu.

     

  • Under “Service-wide definition”, select the type of definition you wish to create, and then type a name for the definition. You can leave the auto-generated name or type a name more meaningful to you.

     

  • Use the sections below to help fill in the details for the type of definition you wish to create, then click “Add Definition”.

Use a geo-region definition to create a custom grouping of countries. For example, you could set up a definition for French-speaking countries (and add France, Canada, Belgium, etc.) or for countries in North America (and add Canada, United States, and Mexico).

For Geo-region definition, select a country from the list to add it to your definition (You can also start typing the country name to save scrolling through the list.). To add another country, click “Add” and select another country. Repeat until you’ve added all the countries of your choice.

Use an IP-group definition to create a custom grouping of IP addresses.

In the “IP Addresses in” field, type an IP address you want to include in the definition. To add another IP address, press “Add” and type another IP address. Please note that you can add IP addresses individually or as a range using CIDR notation.

Use a token-authentication definition you will refer to in a token-authentication match rule. When the client presents the URL to the CDN, the CDN creates its own version of the token using a shared secret and predefined token generation algorithm (sha1). If the client’s token matches the CDN calculated token, the client’s request is allowed to proceed and the requested content is returned to the client. If the client’s token doesn't match, the CDN returns either an HTTP 403 response or 302 temporary redirect.

Add secret names (up to 10) to the definition by clicking on “Add” above the Secret name section, and typing your secret name. Repeat until you’ve added all the secret names you wish to add. Add query parameters to include or exclude from the hash to the definition by clicking on “Add” above the query parameter name section, and typing your query parameter name. Repeat until you’ve added all the query parameter names. The “Query Parameter Control” drop-down is used to define whether to include or exclude these parameter names from the hash. From the Date Preference list, select your preference: EPOCH or GMT. If you want to use a query string other than nva (not valid after), type it in the “NVA Name” field. If you want to use a query string other than nvb (not valid before), type it in the “NVB Name” field. If you want to use a query string other than hash, type it in the Hash field.

You create an AWS4 authentication definition to provide your authentication information to AWS requests sent by HTTP. For security, most requests to AWS must be signed with an access key, which consists of an access key ID and secret access key. These two keys are commonly referred to as your security credentials. (Learn more about understanding and getting your credentials.)

Simply Fill in “Secret” and “Access Key ID” fields with the information yous://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html received from Amazon when you registered.

You can view Lua-scripting definitions CDN Support has added to a configuration (at your request). Once Lumen CDN Support creates a Lua scripting definition for you, you can view it and add it to a match rule, but you can't make changes. The Lua script remains on the configuration for future versions and Media Portal include the Lua script if you copy the configuration to create a new configuration.

Media Portal lists the Lua-scripting definitions for the configuration (if any). If you select one from the list, Media Portal displays the Lua script you selected, the direction for the Lua script (whether the Lua script is for requests, responses, or both), whether the Lua script is designated as heavy, and the execution type (Edge or Fill).

Use log-streaming endpoint definitions to specify when, where, and how you want log streaming information posted to your endpoint. Logs are batched in a JSON-formatted payload and posted to your endpoint in near real time (<5 minutes). You can add a log-streaming endpoint definition only if you've purchased Log Streaming. If you feel you should have access to this feature and don't, open a ticket with CDN Operations.

Please note that If you have large traffic volumes, be sure your endpoint can handle a large amount of log information. If your endpoint can't handle the volume, you may lose log data because the Lumen log-processing system only queues logs for a short period of time if your endpoint is unavailable or unable to keep up.

From the “Log Format” list, select the format you want the log to use: “JSON_Newline” or “JSON_Array”. If you want to check whether the presented certificate CN (common name) matches the hostname, select the “Validate Certificate” checkbox. From the “Protocol” list, select the protocol you want to use to deliver the logs. In the “Host” and “Port” field, type the hostname and port of the remote server respectively. In the “Max Bites per Message” field, type the maximum number of bytes of log data that will be sent in each post. In the “Path” field, type the path where the logs will be placed on the remote server. In the “Max Post Interval” field, type the maximum time the system will hold logs until they are sent to the remote server (if the log hasn't yet reached the number of bytes you specified above). In the “Connections” field, select the number of connections. To create custom headers to be added to the requests, click “Add”, then type the name and value for the request header. You can add multiple headers by clicking “Add” again.

 

Use request-header definitions to create a custom header in requests sent up stream to their origin.

In the “Header Name” field, type the name of the request header and in the “Header Value” field, type the value to be returned for that header. To add additional headers, click “Add”, then repeat the steps.

Use a response-header definition to return custom header responses to specific requests.

To specify categories of HTTP status codes you want to include in the definition, select the checkbox(es) next to those categories. You can also select the “Custom Status Code” checkbox and specify other status codes (separated by a comma) in the field that appears. Alternatively, you can add all status codes to the definition by selecting the “All Responses” checkbox. Next, fill in the information for the response header. In the “Header Name” field, type the name of the response header. In the “Header Value” field, type the value to be returned for that header. To add additional headers, click “Add”, then repeat the steps.

Dynamic content transformation (DCT) allows your origin server to serve a single variant of an object, either identity or gzip, and have the Lumen CDN dynamically transform that content into the desired variant. Use a DCT definition to specify the file extensions you want DCT applied to.

To add extensions to the definition that you'd like DCT applied to, type an extension in the “extensions” field. To add additional extensions, click “Add”, then fill in the field. To make this definition the default DCT definition for the configuration, click the “Default” checkbox.

By default, encodings are normalized to either Identity or Gzip. Any other encodings are automatically dropped from the request. However, you may override this by creating an accept-encoding definition that is attached to a property-based setting. 

Creating an accept-encoding definition allows you to specify extensions and compression types that should be accepted if included in a client’s request. Please note that the CDN will not transform or compress files. The file and compression types must be supported by the origin. Furthermore, normalization never causes the Lumen CDN to serve an encoding that was not requested or that the client has specified as unacceptable.

Add extensions and compression types to the respectively labeled fields and if you wish to add additional extensions and compression types, click on the “add” button above the respective field.

  • If you need to edit or add other definitions, continue editing the configuration without saving (saving the configuration creates a new version).

     

When you're done editing the configuration, click “Save” (above the “Service-wide Definition” section). You can also click “Save as” to save the configuration under a new name. Finally, make any notes to describe the changes you made (if needed), and click “Save” again.