Concepts and terms
To get the most out of Delivery Manager, understand its core components, key concepts, and how everything works together.
Components and terminology
Beta availability*Items marked with an asterisk are not available during the initial Beta testing period.
Accounts
Your account is set up by your Akamai account team. You can work with your account representative to set up contracts that enable certain products and services. You can also set up *account-level rules and settings that are enforced across all your configured services.
Activation
Activation occurs when configuration changes are pushed across either Akamai’s staging or production networks. In Delivery Manager, service hostname sets and environments are independent components that you can activate in tandem or separately. Service hostname sets must be routed to an environment prior to activation, and both must be activated to the same network. See Activation workflows.
- Service hostname set activation. After a service hostname set is routed to one or more environments, you can activate it to either Akamai’s staging or production networks.
- Environment activation. Once you configure an environment’s settings and rules, you can activate it to either Akamai’s staging or production networks as defined by the environment’s profile (production, testing, or development). New environment versions must be activated in order to serve traffic.
Certificates
There are two types of certificates used in Delivery Manager configurations:
- Edge certificate. An edge certificate protects the connection between end-user requests and Akamai edge servers. Edge certificates are provisioned and applied for each service hostname with selectable security levels, including standard or enhanced TLS.
- Origin certificate. Used to secure the connection between an origin server and Akamai edge servers. Origin certificates are required for custom and third-party origins, and are managed outside of Akamai. A certificate must be in place for Akamai to successfully verify a secure connection for your origin server.
Contracts
Your contract is set up by your Akamai account team and determines the products, modules, and services available to users within your account. Each account can have multiple contracts, and authorized users can switch between contracts within the account to set up subsequently enabled services. Workspaces aren’t shared across contracts.
Edge hostnames
An Akamai-generated hostname like www.example.com.edgekey.net that acts as a DNS-based CNAME target that redirects requests for your service hostname to Akamai’s distributed edge servers for faster, secure content delivery. When users request your site, for example www.example.com, DNS sends them to the nearest edge server, which then delivers your content based on your rules.
Environments
Each environment is an isolated deployment within a workspace that has its own versioned configurations and rule logic. Environments represent a given lifecycle stage for your application or service, like production or testing, and *utilize clone, merge, and promotion features for safe CI/CD and GitOps-based workflows. See Environments for more details.
Environment profile
Environments use environment profiles to serve as blueprints for application lifecycle stages and provide a safe means of deploying changes between environments. The default environment profiles are:
- *Development: Used for rapid iteration and non-production feature development. Development profiles are temporary, ephemeral environments with access to Akamai’s staging network. Environments with a development profile expire at a predetermined timestamp where all environment-related artifacts are deactivated automatically.
- *Testing: Used for regression, non-production, and pre-production testing. Testing profiles are permanent, persistent environments with access to Akamai’s staging and production networks.
- Production: Used for serving live, end-user traffic. Production profile defines permanent, persistent environments with access to Akamai's staging and production networks. Only one production environment profile can be active at a time, though it can be active on both staging and production network simultaneously. In contrast, you can have multiple active instances of development or testing environment profiles.
Environment version
All new environments created default to version 1 (v1) where version 1 includes all rule-related information and any environment-level variable overrides. Once an environment is active, you must create a new version to make any changes to rule configurations or execution order. See Environment versions for more details.
Groups
You manage permissions to workspace components through Identity & Access Management group assignments.
The primary group acts as the primary owner of the workspace, establishing core administrative control. Any resources or downstream data generated within the workspace automatically inherit this group assignment. You typically assign this to the core platform team that builds, maintains, and holds operational responsibility for the application or service.
Additional groups provide a safe mechanism for cross-team collaboration. You can use these groups to grant fine-grained, functional access to secondary teams who need to interact with, view, or test specific components, such as individual environments or rule sets, without owning the underlying infrastructure.
Modules
Packaged add-ons to specific products, like Ion, that enable additional features in the form of rule matches and behaviors. Modules are enabled at the contract-level, and you can see which modules are enabled once you create a workspace. The active products and modules you have access to dictate whether or not you can use certain rules in your environment rule configurations.
Origin
The backend server that hosts the authoritative version and deliverable components for your application or service. Edge servers regularly ping origin servers so they can cache and deliver the most up-to-date versions of your content. Origins are defined by authorized users as a combination of basic network settings like DNS name, hostname or IP, and port. See Origins for more details.
Routes
Routes map service hostname sets to environments. You can route a service hostname set to one or more environments within a workspace. This lets you direct requests to specific environments that may contain different variants of your deployment, using either host-based routing for testing and production environments, or *header-based routing for rapid developer iteration. See Routes for more details.
Rules
Sets of logic that use matches and behaviors to determine how to handle end-user requests for your site or application. Rules use an IF/THEN style configuration where matches are IFS and behaviors are THEN. Rules can live at the platform, account, contract, or environment levels. For a catalog of features to use within rules, see Delivery Manager Rules.
Rule configuration
The ordered arrangement of rules and rule sets that determine how requests get served your content. Rule configurations work from the top down, with rules at the bottom of the configuration taking precedence. In Delivery Manager, you can edit your rule configuration from the Rules tab in your environment. See Rule configuration logic for more details.
Rule sets
Containers that let you group one or more rules together based on a common purpose like use case, function, or role-based access control (RBAC) and ownership requirements. For example, you can configure users and roles to grant access to specific rule sets based on team responsibilities and work scope.
Settings
A set of predefined, environment-level default settings that vary depending on your product. Settings can be deactivated as needed or overwritten by more specific custom rules in an environment’s rule configuration. See Settings for more details.
Custom rule set (environment-level)
User-created sets of rule logic specific to an individual environment. You can save custom rule sets to be accessible to other environments within a workspace by upgrading them to shared rule sets. See Custom rule sets for more details.
*Shared rule set (contract-level)
User-created rules shared and made available to all workspaces and environment configurations in a contract. Shared rule sets can be helpful for creating common, iterable policies or organizational standards across environments.
*Admin rule set (account-level)
Rules set up and enforced at the account level that apply to all configurations within that account. Admin rule sets can be used to enforce global delivery standards for things like traffic control, security headers, and logging.
*Platform rule sets (platform-level)
A library of Akamai-curated, predefined rules based on industry best practices and product optimizations. Preconfigured rule sets are set up with default values, customizable, and available to all Akamai accounts and users unless permissions dictate otherwise. You can search for and use platform rule sets when configuring rules in an environment.
Rule set order
The ordered sequence of rule sets in an environment’s rule configuration. The rule set order can be defined and configured in an environment’s rule tab. The main reference file used with the API, ruleSetOrder, defines the order in which edge servers execute and apply rules to requests for your content.
Match
The condition (IF) that determines whether or not a behavior is triggered by a request.
Behavior
The result (THEN) of what happens to a request based on the condition met by a match. See Behaviors for more details.
Service hostnames
Define the fully qualified domain names (FQDN) for your application or site for content delivery. This is what your end-users see. Once configured and activated, service hostnames map client requests to edge servers.
Service hostnames are grouped into sets. Service hostname sets act as a container allowing you to centrally manage common hostname settings like environment routing, certificates, edge hostname mapping, and TLS. See Service hostnames for more details.
Workspaces
The top, or root-level containers for a CDN configuration. A workspace groups multiple components for delivering a site or application, including environments, service hostnames, origins, variables, routes, and certificates. Workspaces are available to one contract at a time. See Workspaces for more details.
Variables
Named containers that let you define and update specific values and parameters, separating configuration from application logic, and giving you reusable, flexible data items with fewer deployment errors. Variables live at the workspace level and can be referenced across different environments. Updating a variable value at the workspace level updates the value across all configurations within the workspace. See Variables for more details.
Variable overrides
Authorized users can edit a variable value at the environment level, resulting in a variable override.
Versions
Point-in-time snapshots of a specific configuration. A versioned component remains editable until you activate the resource version. Once activated, the version is no longer editable, and you need to create a new one to change its settings. For example, if you make edits to an environment configuration, you need to create a new draft environment version while the previous version remains active. Components that utilize versioning include environments, service hostname sets, rule sets, and variables.
Updated about 2 months ago
