One of the key design challenges we are seeking to solve for developers is to enable a promotional deployment model with the Akamai Property Manager API. In this session, you'll get a sneak peek of how we are planning to solve this challenge -- and you'll help us build it! In addition, you'll learn how existing Property Manager API use cases can help solve some of your operational and business needs.

1. © AKAMAI - EDGE 2017
PAPI and Promotional Deployment
Mark Van Horn, Director of Software Engineering

2. © AKAMAI - EDGE 2017
Overview
What is PAPI?
Some PAPI use cases: What can be done today
•Using variables
•New ease of use changes
•A quick word about frozen rule formats
What’s next
•N-stage deployment pipeline
•Bulk updates of configurations
Q & A

3. © AKAMAI - EDGE 2017
What is PAPI?
The Property Manager API, or PAPI, allows the control of your properties
using a rich API layer instead of the UI.
developer.akamai.com

4. © AKAMAI - EDGE 2017
Some PAPI Use Cases: What can be done today?

5. © AKAMAI - EDGE 2017
Using Variables
• Example: Using variables to do geo redirection with a lookup table
• Edit PM JSON for the variable’s new value in your IDE
• Use PAPI to push changes

6. © AKAMAI - EDGE 2017
Using Variables, cont’d

7. © AKAMAI - EDGE 2017
Using Variables, cont’d

8. © AKAMAI - EDGE 2017
New Ease of Use changes released last week

9. © AKAMAI - EDGE 2017
First, the setup

10. © AKAMAI - EDGE 2017
Using the auth libraries

11. © AKAMAI - EDGE 2017
You can stop using data prefixes

12. © AKAMAI - EDGE 2017
You can choose to ignore contract id, group id

13. © AKAMAI - EDGE 2017
You can validate without saving
• dryRun=true
• validateMode=fast, validateMode=full (defaults to full)

14. © AKAMAI - EDGE 2017
Custom behaviors – coming soon!
Work with your account team to turn pieces of advanced metadata into
reusable snippets
(See hands-on lab outside in Dev Zone for more information)

15. © AKAMAI - EDGE 2017
A Word About Frozen Formats
• What are they?
• Why use them?

16. © AKAMAI - EDGE 2017
A Word About Frozen Formats, cont’d

17. © AKAMAI - EDGE 2017
What’s Next? Two projects we are working on now
• N-stage deployment pipeline
• Bulk updates of configurations

18. to plugin Akamai
into my other
tools
my config
changes & purges
to take effect
immediately
to automate
making the same
change across 100
configs
to unblock self-
serviceability
currently blocked
by advanced
behaviors
my team’s site
health dashboard
to include info
from Akamai
to program Edge
behavior such as
redirects with
JavaScript
to test my
development
stream with
Akamai
to automate
every action I take
in the Akamai
portal
to control Edge
behavior for my
part of the site
independently
from other teams
to automate tests
against Akamai
diagnostic info
As a DevOps user, I want .. 2017 & Beyond
to automate
propagating
changes between
different
environments
Pipeline Needs
Quick Reactions
& Speed
My Developers
to be
empowered
Automation

19. © AKAMAI - EDGE 2017
Deployment Pipeline Use Case
Rather than providing yet another API, create an SDK that manages
templates, environments and variables locally in your environment.
The SDK would use PAPI and other APIs to:
• Provision resources
• Manage properties assigned to a Dev Ops pipeline
• Move changes from one environment (property) to another
• Merging environment specific settings into template locally and submit changes
through API
• Activate properties

20. Akamai Config
Work
Build & Test
Dev & Akamai
Work Promoted
Promote
Development
Work
Akamai
Pipeline
Config
v2
Dev Env QA Env Prod Env
Promote
Akamai
Pipeline
Config
v1
Akamai
Pipeline
Config
v1
Dev & Akamai
Work Promoted
Akamai
Pipeline
Config
v2
Akamai
Pipeline
Config
v2
Future State

21. © AKAMAI - EDGE 2017
● Project
○ JSON template with variable
place holders
○ Table of variable definitions
● Environments
○ Env specific variable values
Deployment Pipeline - High Level Components

22. © AKAMAI - EDGE 2017
Create new DevOps project
create_project –p ION -e dev,qa,staging,prod
devopsexample
setting up project in: projects/devopsexample
writing 'projects/devopsexample/environments/dev/hostnames.json’
writing 'projects/devopsexample/environments/dev/settings.json’
writing 'projects/devopsexample/environments/qa/hostnames.json’
writing 'projects/devopsexample/environments/qa/settings.json’
writing 'projects/devopsexample/environments/prod/hostnames.json’
writing 'projects/devopsexample/environments/prod/settings.json’
writing 'projects/devopsexample/templates/master.json’
...

23. © AKAMAI - EDGE 2017
Fetch Akamai account resources
npm run fetch
Downloading Akamai account resources...
... Product definitions
... Validation rules
... Validation library
... Contract resources
436 kb downloaded

24. © AKAMAI - EDGE 2017
Project Folder Structure

25. © AKAMAI - EDGE 2017
variable_definitions.json
{
"defaults": {
"defaultCpcode": 123456,
"defaultOrigin": "origin.devopsexample.akamai.com",
"defaultTTL": "1d"
},
"definitions": {
"defaultCpcode": {
"type": "cpcode"
},
"defaultOrigin": {
"type": "hostname"
},
"defaultTTL": {
"type": "ttl"
}
}
}

26. © AKAMAI - EDGE 2017
Environment specific files (example: dev)
{
"defaultCpcode": 243543,
"defaultOrigin": "dev-origin.devopsexample.akamai.com",
"defaultTTL": "5s"
}
variables.json
{
"propertyName": "dev.exampledevops.akamai.com",
"latestVersion": 12,
"activeStagingVersion": 11,
"activeProductionVersion": 10
}
settings.json
[
{
"name": "dev.exampledevops.akamai.com",
"cname": "exampledevops.akamai.com.edgesuite.net",
"cnametype": "EDGE_HOSTNAME",
"ipv6": true
},
...
]
hostnames.json

27. © AKAMAI - EDGE 2017
Templates includes (example: main.json)
{
"name" : "rule tree root",
"children" : [
"#include:compression.json",
"#include:dynamic.json",
"#include:static.json"
],
"behaviors" : [
"#include:origin.json", {
"name" : "cpCode",
"options" : {
"cpCode" : {
"id" : "${env.defaultCpcode}"
}
}
}, {
"name" : "caching",
"options" : {
"behavior" : "no-store"
}
}, {
... more behaviors ...
}
}
variable substitution
template includes

28. © AKAMAI - EDGE 2017
{
"name" : "origin",
"options" : {
"type" : "customer",
"forwardhostheader" : "requesthostheader",
"cachekeyhostname" : "originhostname",
"compression" : "on",
"tcip_enabled" : "off",
"http_port" : "80",
"hostname" : "${env.defaultOrigin}"
}
}
{
"name" : "Static Content",
"behaviors" : [ {
"name" : "caching",
"options" : {
"behavior" : "max-age",
"mustrevalidate" : "off",
"ttl" : "${env.defaultTTL}"
}
}, {
"name" : "prefetch",
"options" : {
"enabled" : "off"
}
}, {
"name" : "prefetchable",
"options" : {
"enabled" : "on"
}
} ],
"criteria" : [ {
"name" : "fileExtension",
"options" : {
"value" : [ "aif", ..., "wdp" ],
"result" : "true",
"case" : "off"
}
} ],
"criteriaMustSatisfy" : "all"
}
Included behavior
origin.json:
Included rule for static
content:
Templates includes and variables

29. © AKAMAI - EDGE 2017
Merging
npm run merge:dev
loading 'projects/example/environments/dev/variables.json'
loading 'projects/example/environments/dev/settings.json'
Merging template: 'projects/example/templates/main.json'
Merging template: 'projects/example/templates/compression.json'
Merging template: 'projects/example/templates/dynamic.json'
Merging template: 'projects/example/templates/static.json'
Replacing '${env.defaultTTL}' with: '5s'
Merging template: 'projects/example/templates/origin.json'
Replacing '${env.defaultOrigin}' with: 'dev-origin.devopsexample.akamai.com'
Replacing '${env.defaultCpcode}' with: '243543'
writing 'projects/example/dist/dev.exampledevops.akamai.com.simplified.json'

30. © AKAMAI - EDGE 2017
Validating
npm run validate:dev
loading 'projects/example/cache/Web_App_Accel.json'
loading 'projects/example/cache/property.json'
loading 'projects/example/environments/dev/settings.json'
loading 'projects/example/environments/dev/hostnames.json'
loading 'projects/example/dist/dev.exampledevops.akamai.com.simplified.json'
validationResults: []
writing 'projects/example/dist/dev.exampledevops.akamai.com.json'
writing 'projects/example/dist/dev.exampledevops.akamai.com.validation.json'

31. © AKAMAI - EDGE 2017
Promoting
npm run promote:qa
loading 'projects/example/environments/qa/variables.json'
loading 'projects/example/environments/qa/settings.json'
Promoting to 'qa' environment. Checking status...
'dev' has pending changes, cannot promote. Promote to 'dev' first.

32. © AKAMAI - EDGE 2017
Promoting
npm run promote:dev
loading 'projects/example/environments/dev/variables.json'
loading 'projects/example/environments/dev/settings.json'
Promoting to 'dev' environment. Checking status...
... running merge...
... all merged, saving changes ...
... OK, property 'dev.exampledevops.akamai.com' saved, 25 warnings, activating
...
... activation pending, used FMA route, expected wait time: 5 minutes.

33. © AKAMAI - EDGE 2017
Bulk Updates of configurations

34. © AKAMAI - EDGE 2017
Bulk Updates of configurations - Use Case
• Make the same update in many places and/or configurations
• For example, changing the same origin which lives in many behaviors
across many configurations
Our solution: Make “Rule Templates 2.0” a first class citizen.
* Rule templates 1.0 today – what are they?

35. © AKAMAI - EDGE 2017
Bulk Updates of configurations – How this would work
• Edit a 2.0 rule template
• New endpoints for finding properties using the template
• New endpoints provided for async bulk save/validate
• New endpoints provided for async bulk activate

36. © AKAMAI - EDGE 2017
Rule Include - Modify gzip Example
Client
PAPI API
Step 1: Modify the template
{
"name" : "Rule Include 1",
"children" : [ ],
"behaviors" : [ {
"name" : "gzipResponse",
"options" : {
"behavior" : "ALWAYS"
} ],
“Criteria” : [ {
"name" : "contentType",
"options" : {
"matchOperator" :"IS_ONE_OF",
..
} ]
..
}
Modified Rule include
{
"name" : "Rule Include 1",
"children" : [ ],
"behaviors" : [ {
"name" : "gzipResponse",
"options" : {
"behavior" : "ALWAYS"
} ],
“Criteria” : [ {
"name" : "contentType",
"options" : {
"matchOperator" :"IS_ONE_OF",
..
} ]
..
}

37. © AKAMAI - EDGE 2017
Rule include to search for
Rule Include - Modify gzip Example, cont’d
Client
PAPI API - SEARCH
Step 1b: Search configs that use the template
{includeName : “rule include 1”
}
{
configs : [ {
configId : 123,
Version : [“2”]
latestActive: null
latestUnactive: “2”
} , {
configId: 987,
Version : [“3”, “4”]
latestActive: “4”
latestUnactive: “3”
},
..
]
}
Search Results
Database look up
Configs using
template

38. © AKAMAI - EDGE 2017
Create config based off of version
Rule Include - Modify gzip Example, cont’d
Client PAPI API - Create Version
Step 2: Create new config versions
{
configs : [ {
configId : 123,
version : “2”
} , {
configId: 987,
Version : “3”
},
..
}]
}
{
CreateResultID: 123
configs : [ {
configId : 123,
version : “2”,
results: “success”
} , {
configId: 987,
Version : “3”
Results : “success”
Errors : {.....}
Warnings : {....}
},
..
}]
}
Create results
Database New configs

39. © AKAMAI - EDGE 2017
save + validate
Rule Include - Modify gzip Example, cont’d
Client
PAPI API - Save Version
Step 3: Save and validate configurations
{
configs : [ {
configId : 123,
version : “2”
} , {
configId: 987,
Version : “3”
},
..
}]
}
{
CreateResultID: 123
configs : [ {
configId : 123,
version : “2”,
results: “in progress validation”
Eta : “5 minutes”
} , {
configId: 987,
Version : “3”
Results : “Fail”
Errors : {.....}
Warnings : {....}
},
..
}]
}
Save + validate results
Expand include
Configs

40. © AKAMAI - EDGE 2017
Activate
Rule Include - Modify gzip Example, cont’d
Client
PAPI API - Activate
Step 4: Activate configs and check status
{
configs : [ {
configId : 123,
version : “2”
} , {
configId: 987,
Version : “3”
},
..
}]
}
Configs
{
activationResultId: 888
configs : [ {
configId : 123,
version : “1”,
results: “in progress activation”
Eta : “5 minutes”
} , {
configId: 987,
Version : “lastActiveVersion”
Results : “Fail”
Errors : {.....}
Warnings : {....}
},
..
}]
}
Activation results
activationResultId can be used in a results
endpoint to check status since this will be async

41. © AKAMAI - EDGE 2017
Please take the survey!
akamaidev.io/akamaiascode

42. © AKAMAI - EDGE 2017