diff --git a/site/_docs/architecture/platform-extensions.md b/site/_docs/architecture/platform-extensions.md index 3fcbc618b..36fa807da 100644 --- a/site/_docs/architecture/platform-extensions.md +++ b/site/_docs/architecture/platform-extensions.md @@ -1,7 +1,7 @@ --- layout: docs chapter: Architecture -title: Platform Extensions +title: Platform Extensions permalink: /docs/architecture/platform-extensions/ --- @@ -11,3 +11,21 @@ Platform extensions are defined according to the [platform extension specificati ## Platform Extension Collections Platform extensions can be grouped together into collections so that related platform extensions can be loaded in one go. + +## Platform Extension Types + +There are currently two methods of loading platform extensions. + +### AWS + +This type uses the AWS CloudFormation services to load a template that describe the AWS resources to create. + +Examples + * [adop-platform-extension-chef](https://github.com/Accenture/adop-platform-extension-chef) + +### Docker + +This uses [docker-compose](https://docs.docker.com/compose/) to orchestrate the running of containers. + +Examples + * [adop-platform-extension-clair](https://github.com/kramos/adop-platform-extension-clair) diff --git a/site/_docs/operating/platform-extensions.md b/site/_docs/operating/platform-extensions.md index d207e5dde..f78416a02 100644 --- a/site/_docs/operating/platform-extensions.md +++ b/site/_docs/operating/platform-extensions.md @@ -8,14 +8,18 @@ permalink: /docs/operating/platform-extensions/ Platform extensions provide the ability to extend the core [ADOP stack](/docs/operating/platform/) and add new tools or extensions to existing tools. Below, you will learn how to load a default ADOP platform extension. 1. Access Jenkins -1. Go into "Platform_Management" folder and access "Load_Platform_Extension" job -1. Click on "Build with parameters" -1. Enter the following parameters: - - GIT_URL ```https://github.com/Accenture/adop-platform-extension-specification``` +2. Go into "Platform_Management" folder and access "Load_Platform_Extension" job +3. Click on "Build with parameters" +4. Enter the following parameters: + - GIT_URL ```https://github.com/Accenture/adop-platform-extension-specification``` - GIT_REF ```master``` (By default we would use value 'master', unless you would be developing an extension and specifically require to use a different branch) - - AWS_CREDENTIALS ```Applicable for AWS type of platform extensions``` - 1. For detailed instructions on how to generate AWS credentials, see AWS Credentials - 1. Once you have generated AWS credentials, click on "Add" button and fill in required details as shown below: - Image showing what details to fill out when adding credentials for loading platform extension. - 1. Click "Add". -1. Click "Build". \ No newline at end of file + - CREDENTIALS ```Applicable for AWS and Docker type of platform extensions``` + a. AWS Extensions Type + 1. For detailed instructions on how to generate AWS credentials, see AWS Credentials + 2. Once you have generated AWS credentials, click on "Add" button and fill in required details as shown below: + Image showing what details to fill out when adding credentials for loading platform extension. + 3. Click "Add". + b. Docker Extensions Type ``` Credentials are only required for authenticating against private Docker image repositories ``` + 1. Once you have generated [docker hub](https://hub.docker.com/) credentials, click on "Add" button and fill in required details. + 2. Click "Add". +5. Click "Build".