1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
|
"""
SoftLayer.cdn
~~~~~~~~~~~~~
CDN Manager/helpers
:license: MIT, see LICENSE for more details.
"""
import SoftLayer
from SoftLayer import utils
# pylint: disable=too-many-lines,too-many-instance-attributes
class CDNManager(utils.IdentifierMixin, object):
"""Manage Content Delivery Networks in the account.
See product information here:
https://www.ibm.com/cloud/cdn
https://cloud.ibm.com/docs/infrastructure/CDN?topic=CDN-about-content-delivery-networks-cdn-
:param SoftLayer.API.BaseClient client: the client instance
"""
def __init__(self, client):
self.client = client
self._start_date = None
self._end_date = None
self.cdn_configuration = self.client['Network_CdnMarketplace_Configuration_Mapping']
self.cdn_path = self.client['SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path']
self.cdn_metrics = self.client['Network_CdnMarketplace_Metrics']
self.cdn_purge = self.client['SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge']
self.resolvers = [self._get_ids_from_hostname]
def list_cdn(self, **kwargs):
"""Lists Content Delivery Networks for the active user.
:param dict \\*\\*kwargs: header-level options (mask, limit, etc.)
:returns: The list of CDN objects in the account
"""
return self.cdn_configuration.listDomainMappings(**kwargs)
def get_cdn(self, unique_id, **kwargs):
"""Retrieves the information about the CDN account object.
:param str unique_id: The unique ID associated with the CDN.
:param dict \\*\\*kwargs: header-level option (mask)
:returns: The CDN object
"""
cdn_list = self.cdn_configuration.listDomainMappingByUniqueId(unique_id, **kwargs)
# The method listDomainMappingByUniqueId() returns an array but there is only 1 object
return cdn_list[0]
def get_origins(self, unique_id, **kwargs):
"""Retrieves list of origin pull mappings for a specified CDN account.
:param str unique_id: The unique ID associated with the CDN.
:param dict \\*\\*kwargs: header-level options (mask, limit, etc.)
:returns: The list of origin paths in the CDN object.
"""
return self.cdn_path.listOriginPath(unique_id, **kwargs)
def add_origin(self, unique_id, origin, path, dynamic_path, origin_type="server", header=None,
http_port=80, https_port=None, protocol='http', bucket_name=None, file_extensions=None,
optimize_for="web", compression=None, prefetching=None,
cache_query="include all"):
"""Creates an origin path for an existing CDN.
:param str unique_id: The unique ID associated with the CDN.
:param str path: relative path to the domain provided, e.g. "/articles/video"
:param str dynamic_path: The path that Akamai edge servers periodically fetch the test object from.
example = /detection-test-object.html
:param str origin: ip address or hostname if origin_type=server, API endpoint for
your S3 object storage if origin_type=storage
:param str origin_type: it can be 'server' or 'storage' types.
:param str header: the edge server uses the host header to communicate with the origin.
It defaults to hostname. (optional)
:param int http_port: the http port number (default: 80)
:param int https_port: the https port number
:param str protocol: the protocol of the origin (default: HTTP)
:param str bucket_name: name of the available resource
:param str file_extensions: file extensions that can be stored in the CDN, e.g. "jpg,png"
:param str optimize_for: performance configuration, available options: web, video, and file where:
- 'web' = 'General web delivery'
- 'video' = 'Video on demand optimization'
- 'file' = 'Large file optimization'
- 'dynamic' = 'Dynamic content acceleration'
:param bool compression: Enable or disable compression of JPEG images for requests over
certain network conditions.
:param bool prefetching: Enable or disable the embedded object prefetching feature.
:param str cache_query: rules with the following formats: 'include-all', 'ignore-all',
'include: space separated query-names',
'ignore: space separated query-names'.'
:return: a CDN origin path object
"""
types = {'server': 'HOST_SERVER', 'storage': 'OBJECT_STORAGE'}
performance_config = {
'web': 'General web delivery',
'video': 'Video on demand optimization',
'file': 'Large file optimization',
"dynamic": "Dynamic content acceleration"
}
new_origin = {
'uniqueId': unique_id,
'path': path,
'origin': origin,
'originType': types.get(origin_type),
'httpPort': http_port,
'httpsPort': https_port,
'protocol': protocol.upper(),
'performanceConfiguration': performance_config.get(optimize_for),
'cacheKeyQueryRule': cache_query,
}
if optimize_for == 'dynamic':
new_origin['dynamicContentAcceleration'] = {
'detectionPath': "/" + str(dynamic_path),
'prefetchEnabled': bool(prefetching),
'mobileImageCompressionEnabled': bool(compression)
}
if header:
new_origin['header'] = header
if types.get(origin_type) == 'OBJECT_STORAGE':
if bucket_name:
new_origin['bucketName'] = bucket_name
if file_extensions:
new_origin['fileExtension'] = file_extensions
origin = self.cdn_path.createOriginPath(new_origin)
# The method createOriginPath() returns an array but there is only 1 object
return origin[0]
def remove_origin(self, unique_id, path):
"""Removes an origin pull mapping with the given origin pull ID.
:param str unique_id: The unique ID associated with the CDN.
:param str path: The origin path to delete.
:returns: A string value
"""
return self.cdn_path.deleteOriginPath(unique_id, path)
def purge_content(self, unique_id, path):
"""Purges a URL or path from the CDN.
:param str unique_id: The unique ID associated with the CDN.
:param str path: A string of url or path that should be purged.
:returns: A Container_Network_CdnMarketplace_Configuration_Cache_Purge array object
"""
return self.cdn_purge.createPurge(unique_id, path)
def get_usage_metrics(self, unique_id, history=30, frequency="aggregate"):
"""Retrieves the cdn usage metrics.
It uses the 'days' argument if start_date and end_date are None.
:param int unique_id: The CDN uniqueId from which the usage metrics will be obtained.
:param int history: Last N days, default days is 30.
:param str frequency: It can be day, week, month and aggregate. The default is "aggregate".
:returns: A Container_Network_CdnMarketplace_Metrics object
"""
_start = utils.days_to_datetime(history)
_end = utils.days_to_datetime(0)
self._start_date = utils.timestamp(_start)
self._end_date = utils.timestamp(_end)
usage = self.cdn_metrics.getMappingUsageMetrics(unique_id, self._start_date, self._end_date, frequency)
# The method getMappingUsageMetrics() returns an array but there is only 1 object
return usage[0]
@property
def start_data(self):
"""Retrieve the cdn usage metric start date."""
return self._start_date
@property
def end_date(self):
"""Retrieve the cdn usage metric end date."""
return self._end_date
def edit(self, identifier, header=None, http_port=None, https_port=None, origin=None,
respect_headers=None, cache=None, cache_description=None, performance_configuration=None):
"""Edit the cdn object.
:param string identifier: The CDN identifier.
:param header: The cdn Host header.
:param http_port: The cdn HTTP port.
:param https_port: The cdn HTTPS port.
:param origin: The cdn Origin server address.
:param respect_headers: The cdn Respect headers.
:param cache: The cdn Cache key optimization.
:param performance_configuration: The cdn performance configuration.
:returns: SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping[].
"""
cdn_instance_detail = self.get_cdn(str(identifier))
config = {
'uniqueId': cdn_instance_detail.get('uniqueId'),
'originType': cdn_instance_detail.get('originType'),
'protocol': cdn_instance_detail.get('protocol'),
'path': cdn_instance_detail.get('path'),
'vendorName': cdn_instance_detail.get('vendorName'),
'cname': cdn_instance_detail.get('cname'),
'domain': cdn_instance_detail.get('domain'),
'origin': cdn_instance_detail.get('originHost'),
'header': cdn_instance_detail.get('header')
}
if cdn_instance_detail.get('httpPort'):
config['httpPort'] = cdn_instance_detail.get('httpPort')
if cdn_instance_detail.get('httpsPort'):
config['httpsPort'] = cdn_instance_detail.get('httpsPort')
if header:
config['header'] = header
if http_port:
config['httpPort'] = http_port
if https_port:
config['httpsPort'] = https_port
if origin:
config['origin'] = origin
if respect_headers:
config['respectHeaders'] = respect_headers
if cache or cache_description:
if 'include-specified' in cache['cacheKeyQueryRule']:
cache_key_rule = self.get_cache_key_query_rule('include', cache_description)
config['cacheKeyQueryRule'] = cache_key_rule
elif 'ignore-specified' in cache['cacheKeyQueryRule']:
cache_key_rule = self.get_cache_key_query_rule('ignore', cache_description)
config['cacheKeyQueryRule'] = cache_key_rule
else:
config['cacheKeyQueryRule'] = cache['cacheKeyQueryRule']
if performance_configuration:
config['performanceConfiguration'] = performance_configuration
return self.cdn_configuration.updateDomainMapping(config)
def _get_ids_from_hostname(self, hostname):
"""Get the cdn object detail.
:param string hostname: The CDN identifier.
:returns: SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping[].
"""
result = []
cdn_list = self.cdn_configuration.listDomainMappings()
for cdn in cdn_list:
if cdn.get('domain', '').lower() == hostname.lower():
result.append(cdn.get('uniqueId'))
break
return result
@staticmethod
def get_cache_key_query_rule(cache_type, cache_description):
"""Get the cdn object detail.
:param string cache_type: Cache type.
:param cache: Cache description.
:return: string value.
"""
if cache_description is None:
raise SoftLayer.SoftLayerError('Please add a description to be able to update the'
' cache.')
cache_result = '%s: %s' % (cache_type, cache_description)
return cache_result
def delete_cdn(self, unique_id):
"""Delete CDN domain mapping for a particular customer.
:param str unique_id: The unique ID associated with the CDN.
:returns: The cdn that is being deleted.
"""
return self.cdn_configuration.deleteDomainMapping(unique_id)
def create_cdn(self, hostname=None, origin=None, origin_type=None, http=None, https=None, bucket_name=None,
cname=None, header=None, path=None, ssl=None):
"""Create CDN domain mapping for a particular customer.
:param str hostname: The unique ID associated with the CDN.
:param str origin: ip address or hostname if origin_type=server, API endpoint for
your S3 object storage if origin_type=storage
:param str origin_type: it can be 'server' or 'storage' types.
:param int http: http port
:param int https: https port
:param str bucket_name: name of the available resource
:param str cname: globally unique subdomain
:param str header: the edge server uses the host header to communicate with the origin.
It defaults to hostname. (optional)
:param str path: relative path to the domain provided, e.g. "/articles/video"
:param str ssl: ssl certificate
:returns: The cdn that is being created.
"""
types = {'server': 'HOST_SERVER', 'storage': 'OBJECT_STORAGE'}
ssl_certificate = {'wilcard': 'WILDCARD_CERT', 'dvSan': 'SHARED_SAN_CERT'}
new_origin = {
'domain': hostname,
'origin': origin,
'originType': types.get(origin_type),
'vendorName': 'akamai',
}
protocol = ''
if http:
protocol = 'HTTP'
new_origin['httpPort'] = http
if https:
protocol = 'HTTPS'
new_origin['httpsPort'] = https
new_origin['certificateType'] = ssl_certificate.get(ssl)
if http and https:
protocol = 'HTTP_AND_HTTPS'
new_origin['protocol'] = protocol
if types.get(origin_type) == 'OBJECT_STORAGE':
new_origin['bucketName'] = bucket_name
new_origin['header'] = header
if cname:
new_origin['cname'] = cname + '.cdn.appdomain.cloud'
if header:
new_origin['header'] = header
if path:
new_origin['path'] = '/' + path
origin = self.cdn_configuration.createDomainMapping(new_origin)
# The method createOriginPath() returns an array but there is only 1 object
return origin[0]
|