[{"_1":2,"_155":-5,"_156":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_134":135},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":17},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":11,"_131":-5,"_132":133},"canonicalUrl","https://hub.docker.com/r/synedra/akamaiconfigkit-public/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","synedra","reponame","akamaiconfigkit-public","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":17,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2017-06-08T22:02:05.570215Z","description","Akamai CLI Docker Image","is_private","last_updated","2017-06-14T17:01:31.322714Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",307,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# AkamaiConfigKit - PREVIEW\n\n*NOTE:* This is a preview release. There are various limitations and we're still working on feature completeness. We will respond to opened issues promptly during business hours. Caveats can be found at the [bottom](#caveats) of this readme file.\n\n## Get Started\nTo get started using the library, you will need to set up your system for a local install. A docker image is coming soon.\n\n### Local Install\n* Node 7\n* npm install akamaiconfigkit\n* Ensure that the 'bin' subdirectory is in your path\n\n### Credentials\nIn order to use this configuration, you need to:\n* Set up your credential files as described in the [authorization](https://developer.akamai.com/introduction/Prov_Creds.html) and [credentials](https://developer.akamai.com/introduction/Conf_Client.html) sections of the Get Started pagegetting started guide on developer.akamai.comthe developer portal. \n* When working through this process you need to give grants for the property manager API and the User Admin API (if you will want to move properties). The section in your configuration file should be called 'papi'.\n\n## Overview\nThe Akamai Config Kit is a set of nodejs libraries that wraps Akamai's {OPEN} APIs to help simplify common configuration tasks. \n\nThis kit can be used in different ways:\n* [As a no-fuss command line utility](#updateWebSite) to interact with the library.\n* [As a library](#library) you can integrate into your own Node.js application.\n* [As a gulp integration](#gulp) to integrate with your Continuous Integration/Continuous Deployment toolset.\n\n\n## Functionality (version 0.0.1)\nThe initial version of the ConfigKit provides the following functionality:\n* Create a new version from locally stored rules\n* Copy a configuration between properties\n * Currently does not support advanced metadata\n* Create or clone a new property\n * Accepts cpcode, contract ID and hostnames\n* Delete a property\n* Activate and deactivate property versions to production, staging or both\n\n## akamaiProperty\nThis script wraps all of the functionality from the [library](#library) into a command line utility which can be used to support the following use cases. All of the functions accept a property ID, the config name or a hostname from the property.\n* [Create property](#create)\n* [Retrieve property rules](#retrieve)\n* [Update a property](#update)\n* [Activate or deactivate](#activate)\n* [Modify a property](#modify)\n\n### Create\nCreating a new property requires only a single parameter, the target property. \n\n```bash\n% akamaiProperty create dev7.mydomain.com << New property from scratch\n% akamaiProperty create dev7 --clone template1 --hostnames test.hostname.com << clone from another property\n```\n\nThe flags of interest for create are:\n\n```\n -h, --help output usage information\n --clone Source property to clone from\n --srcver Version for source property stag/prod/latest/ (default is latest)\n --file Source file for new property rules\n --hostnames Comma delimited list of hostnames for property\n --origin Origin for new property\n --edgehostname Edge hostname\n --cpcode CPCode, requires contract and group\n --contract Contract for the new property\n --group Group to place property in\n --section

Section of the credentials file\n --nocopy Do not copy source property's hostnames\n\n```\n### Retrieve\nThis function retrieves the specified ruleset, either to STDOUT or the file specified by the --file flag\n\n```bash\n% akamaiProperty retrieve new.property.name\n```\n\nThe flags of interest for retrieve are:\n```\n -h, --help output usage information\n --file Output file (default is STDOUT)\n --propver Property version, latest/staging/prod or number\n --section

Section of the credentials file\n\n```\n\n### Update\nUpdate the current property version with the rules from a local file, or copy from another property.\n\n```bash\n% akamaiProperty update my.property.com --srcprop this.other.property.com\n% akamaiProperty update my.property.com --file myrules.json\n```\n\nThe flags of interest for update are:\n```\n -h, --help output usage information\n --srcprop Source property to copy rules from\n --srcver Version for source property stag/prod/latest/ (default is latest)\n --file Source file for property rules\n --section

Section of the credentials file\n```\n\n### Activate\nActivate the specified property version on staging, production or both.\n\n```bash\n% akamaiProperty activate my.property.com --network BOTH\n```\nPossible options are:\n```bash\n -h, --help output usage information\n --network Network to activate, PROD/STAG/BOTH\n --propver Property version, latest/staging/prod or number\n --section

Section of the credentials file\n --email Email to use for confirmation\n```\n\n### Modify\nModify meta information about the property such as:\n* Origin server\n* Hostnames associated with the property\n* Edge hostnames\n* Group\n\n```bash\n% akamaiProperty modify my.property.com --origin new.origin.hostname\n```\n\nPossible options are:\n```bash\n -h, --help output usage information\n --section

Section of the credentials file\n --addhosts Comma delimited list of hostnames to add\n --delhosts Comma delimited list of hostnames to delete\n --edgehostname Edge hostname to switch the property to\n --origin Switch the property origin server\n --move Move property to a new property group\n```\n\n## Gulp\n\nDownload the Gulp integration project from https://github.com/akamai-open/gulp-akamaiconfigkit\n\nIn your gulpfile, include the library and define your build targets.\n\n```\nlet gulp = require('gulp'),\n akamaiconfig = require('gulp-akamaiconfigkit');\n\nconst localConfig = {\n host: 'www.example.com',\n smokeTestUrls: ['/'],\n emailNotification: 'nobody@akamai.com',\n\n};\n\nconst credConfig = {\n path: \"~/.edgerc\",\n section: \"papi\"\n}\n\n\nlet akamai = new akamaiconfig(credConfig);\n\ngulp.task('deploy-akamai', () => {\n return gulp.src(\"src/akamai/rules.json\")\n .pipe(akamai.deployStaging(localConfig))\n .pipe(akamai.testStaging(localConfig.host, localConfig.smokeTestUrls))\n .pipe(akamai.promoteStagingToProduction(localConfig));\n})\n```\n\nThis integration can be used to have a CD tool such as Jenkins push changes to Akamai whenever a rules file changes in your SCM. This allows you to treat your configuration as code and keep your own rules locally.\n\n## Library\n\nStart with creating the WebSite object:\n\n```\nlet WebSite = require('akamaiconfigkit').WebSite;\nlet exampleDotCom = new WebSite();\n\nexampleDotCom.copy(\"qa-www.example.com\", \"sage-www.example.com\")\n .then(data -> { console.log(\"Rules copied accross Akamai configurations!\")});\n```\n\nThis will use the [default] credentials in the ~/.edgerc file. Alternate object creations include:\n\nSpecifying to use the `[continuous_delivery]` section in the file `/cyberark/edgerc`\n\n```\nlet exampleDotCom = new WebSite({path:\"/cyberark/edgerc\", section: \"[continuous_delivery]\"});\n```\n\nYou can alternatively specify the `clientToken`, `clientSecret`, `accessToken`, and `host` as properties of the\nconstructor object\n\n```\nlet exampleDotCom = new WebSite({clientToken:\"a1b2\", clientSecret: \"c3d4\", accessToken: \"e5f6\", host: \"g7h8.luna.akamaiapis.net\"});\n```\n\n## Caveats\nThe Akamai CLI is a new tool and as such we have made some design choices worth mentioning.\n* Edge Hostnames - if not specified, the system will select an edge hostname from the account to use. Watch the output to know what host to point your DNS at\n* CPCodes - there is currently a fairly strict limitation on creation of CPCodes. To work around this, pass in a specific CPCode to use. Your account team can create a bunch of CPCodes which you could then use with your properties.\n* Credentials - the tool expects your credentials to be stored under a 'papi' section in your ~/.edgerc file. If you are unfamiliar with the authentication and provisioning for OPEN APIs, see the \"Get Started\" section of https://developer.akamai.com\n* Activations - there is currently an intermittent issue with activations not working. It should resolve after another try, and there is an existing internal issue to resolve this.\n* Move - in order to perform move functions, the credentials must have both property manager and user admin grants. \n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",390146646,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},"content_type","creator",173688,"full_size",305938147,"id",11708156,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},"architecture","amd64","digest","sha256:6e2d4b349466d4b62d3648e02e90a1e6c150e3c499dc7aeea135e6950a153325","features","","last_pulled","2026-09-29T03:18:05.661193228Z","last_pushed","2017-06-14T17:01:31Z","os","linux","os_features","os_version","size","variant","2017-06-14T17:01:30.951169Z","last_updater","last_updater_username","media_type","latest","repository",1557381,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":136,"_143":144,"_132":153,"_154":11},{"_36":137,"_38":138,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":139,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":140,"_75":17,"_76":142,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":141},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_145":60,"_146":-5,"_147":-5,"_148":149},"count","next","previous","results",[150],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":151,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},[152],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},[],"canDeleteTags","actionData","errors"]

synedra/akamaiconfigkit-public

Tags for synedra/akamaiconfigkit-public