Skip to content

Commit c7a3e02

Browse files
authored
Add docs for setting up the Akamai CDNs for managed dedicated (#505)
* Add docs for setting up the Akamai CDNs for managed dedicated
1 parent d38c0d4 commit c7a3e02

7 files changed

+87
-0
lines changed

docs/dedicated/akamai/cdn.md

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: Setting up Akamai CDNs
3+
sidebar_label: Akamai CDN
4+
---
5+
6+
When running managed dedicated on the Akamai Cloud, you need to set up 2 CDNs,
7+
one for your API endpoint deployments, and one for your developer portal.
8+
9+
This document outlines the configurations you need to add to your Akamai CDNs to
10+
set them up to access your API gateway and developer portal.
11+
12+
All configurations in this guide were done on the Akamai Property Manager, see
13+
the
14+
[Akamai docs](https://techdocs.akamai.com/property-mgr/docs/know-your-around)
15+
for more details.
16+
17+
### Prerequisites
18+
19+
1. Provision the domains that you would like these CDNs to have and certificates
20+
for those domains. You will need a domain for the API gateway, as well as a
21+
domain for the dev portal.
22+
2. Request the Origin URLs for your API gateway and developer portal from your
23+
Zuplo account manager.
24+
3. Let your Zuplo account manager know what hostnames/domains you will be using
25+
in your CDNs.
26+
27+
## API Gateway CDN
28+
29+
This section guides you on how to configure your API Gateway CDN.
30+
31+
Add the API gateway domain you provisioned to the Property Hostname for the API
32+
Gateway CDN. See the Akamai docs on
33+
[configuring HTTPS hostnames](https://techdocs.akamai.com/property-mgr/docs/serve-content-over-https).
34+
35+
Make the following behavior changes:
36+
37+
1. Configure the Origin URL to point to the URL given to you by Zuplo for your
38+
API gateway. Ensure that the Forward Host Header is configured to be the
39+
Origin Hostname. This would look something similar to below:
40+
![api_gateway_origin_url](../../../public/media/managed-dedicated-akamai/api_gateway_origin_url.png)
41+
42+
2. Turn on Content Targeting (Edgescape) in the Geolocation rule in the Property
43+
Manager Sidebar.
44+
![geolocation](../../../public/media/managed-dedicated-akamai/geolocation.png)
45+
46+
3. Enable all Allowed Methods rules (POST, OPTIONS, PUT, DELETE, PATCH) in the
47+
Property Manager sidebar.
48+
49+
## Developer Portal CDN
50+
51+
This section guides you on how to set up the Developer Portal CDN.
52+
53+
Add a property hostname with a wildcard to your Developer Portal CDN, similar to
54+
below:
55+
56+
![wildcard_domain](../../../public/media/managed-dedicated-akamai/dev_portal_cdn_wildcard_hostname.png)
57+
58+
Under the Default Rule page, add the following behaviors:
59+
60+
1. Configure the origin URL to be the URL given to be the one given to you by
61+
Zuplo for your Developer Portal. This will look similarly to how you
62+
configured it for your API Gateway CDN.
63+
64+
2. Modify Incoming Request Header behavior, with the following fields: Action:
65+
Add, Select Header Name: Other, Custom Header Name: X-Forwarded-Host, Header
66+
Value: \{\{builtin.AK_HOST\}\}. This should look like the picture below:
67+
68+
![dev_portal_cdn_base_path_and_incoming_header_behaviors](../../../public/media/managed-dedicated-akamai/default_rule_dev_portal_config.png)
69+
70+
3. Caching, which should have the following configurations: Caching Option
71+
should be set to "Honor origin Cache-Control and Expires", Force Validation
72+
of stale objects should be set to "Always revalidate with origin", Default
73+
Maxage should be set to 0 seconds, and all the Cache-Control header
74+
directives should be enabled. This will look like below:
75+
76+
![dev_portal_caching_behavior](../../../public/media/managed-dedicated-akamai/dev_portal_cdn_caching_behavior.png)
77+
78+
Congratulations, you've set up your Akamai CDNs to serve your API Gateway and
79+
Developer Portal! At this point, you should be able to test that these things
80+
are working by either hitting an endpoint in your API gateway (e.g
81+
mygateway.com/my/endpoint), or navigating to a page in your developer portal
82+
(e.g myportal.com/home).
Loading
Loading
Loading
Loading
Loading

sidebar.ts

+5
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,11 @@ export const docs: SidebarEntry = [
136136
"dedicated/architecture",
137137
"dedicated/networking",
138138
"dedicated/custom-domains",
139+
{
140+
type: "category",
141+
label: "Akamai",
142+
items: ["dedicated/akamai/cdn"],
143+
},
139144
],
140145
},
141146
{

0 commit comments

Comments
 (0)