diff --git a/docs/api.md b/docs/api.md index e2673be..9814eb5 100644 --- a/docs/api.md +++ b/docs/api.md @@ -7,3 +7,6 @@ link: "http://docs.continuousphp.apiary.io/" order: 18 sitemap: false --- + + +You can find a comprehensive api documentation [here](https://continuousphp.docs.apiary.io/#reference/terms-&-conditions-acceptance/terms-conditions-acceptance-collection). diff --git a/docs/assets/doc/deployment/aws-ecr/destination.png b/docs/assets/doc/deployment/aws-ecr/destination.png new file mode 100644 index 0000000..7cabcca Binary files /dev/null and b/docs/assets/doc/deployment/aws-ecr/destination.png differ diff --git a/docs/assets/doc/deployment/aws-ecr/iam-credentials.png b/docs/assets/doc/deployment/aws-ecr/iam-credentials.png new file mode 100644 index 0000000..f9a69d7 Binary files /dev/null and b/docs/assets/doc/deployment/aws-ecr/iam-credentials.png differ diff --git a/docs/assets/doc/deployment/aws-ecr/packaging.png b/docs/assets/doc/deployment/aws-ecr/packaging.png new file mode 100644 index 0000000..a98b3dc Binary files /dev/null and b/docs/assets/doc/deployment/aws-ecr/packaging.png differ diff --git a/docs/deployment/aws-code-deploy.md b/docs/deployment/aws-code-deploy.md index c26832c..c417b40 100644 --- a/docs/deployment/aws-code-deploy.md +++ b/docs/deployment/aws-code-deploy.md @@ -10,7 +10,7 @@ excerpt: "Deploy your applications to AWS EC2 in a few clicks." [AWS CodeDeploy](https://aws.amazon.com/codedeploy) allows you to deploy your applications directly to Amazon EC2 instances. ## Specify your AWS credentials -To deploy to your AWS account, continuousphp needs an IAM key and secret. You can specify them in the 1st step of the project +To deploy to your AWS account, continuousphp needs access keys for IAM users. You can specify them in the 1st step of the project setup or simply when adding a new pipeline to your existing project. ![AWS IAM credentials](/assets/doc/deployment/aws-code-deploy/iam-credentials.png) @@ -35,4 +35,4 @@ can be found in the [AWS CodeDeploy documentation](http://docs.aws.amazon.com/co Make sure that the IAM credentials you provide only have the strict minimum of permissions. Example: The provided IAM credentials shouldn't be able to erase your S3 storage. -And that's it! You just configured your application to be deployed with AWS CodeDeploy. \ No newline at end of file +And that's it! You just configured your application to be deployed with AWS CodeDeploy. diff --git a/docs/deployment/aws-ecr.md b/docs/deployment/aws-ecr.md new file mode 100644 index 0000000..b776677 --- /dev/null +++ b/docs/deployment/aws-ecr.md @@ -0,0 +1,41 @@ +--- +layout: doc +title: "AWS ECR - Documentation" +category: "deployment" +logo: aws-ecr +order: 6 +excerpt: "Deploy your containers to AWS ECR in a few clicks." +--- + +[AWS ECR](https://aws.amazon.com/ecr) is a fully-managed Docker container registry that makes it easy for developers to store, manage, and deploy Docker container images. + +## Specify your AWS credentials +To deploy to your AWS account, continuousphp needs access keys for IAM users. You can specify them in the 1st step of the project +setup or simply when adding a new pipeline to your existing project. + +![AWS IAM credentials](/assets/doc/deployment/aws-ecr/iam-credentials.png) + +## Configure the Packaging +After having configured the tests in the second step, you can now enable Docker in the Packaging configuration. + +![AWS packing](/assets/doc/deployment/aws-ecr/packaging.png) + +## Configure the Deployment +Once you have added the IAM credentials and you defined Docker as packaging method, you can configure the deployment in the 4th step of the project/pipeline setup. + +![AWS deployment](/assets/doc/deployment/aws-ecr/destination.png) + +## Use environment variables to define your tags +continuousphp provides you with a set of built-in environment variables that you can use to define your tags. Moreover you may want to truncate those variables then you can use the following syntax : + +* ***CPHP_GIT_COMMIT*** : 225ff5830d804093869e5d8b6516aa7b +* ***${CPHP_GIT_COMMIT}*** : 225ff5830d804093869e5d8b6516aa7b +* ***${CPHP_GIT_COMMIT:0,7}*** : 225ff58 +* ***${CPHP_GIT_COMMIT:7}*** : 30d804093869e5d8b6516aa7b +* ***${CPHP_GIT_COMMIT:-12}*** : 5d8b6516aa7b + +!!! note "**IMPORTANT**" + Make sure that the IAM credentials you provide only have the strict minimum of permissions. For instance + the provided IAM credentials shouldn't be able to erase your ECR repository. + +And that's it! You just configured your Dockerfile to be deployed with AWS ECR. diff --git a/docs/deployment/aws-elastic-beanstalk.md b/docs/deployment/aws-elastic-beanstalk.md index b83fdc1..a12a138 100644 --- a/docs/deployment/aws-elastic-beanstalk.md +++ b/docs/deployment/aws-elastic-beanstalk.md @@ -10,7 +10,7 @@ excerpt: "Deploy your applications to AWS EC2 in a few clicks." [AWS Elastic Beanstalk](https://aws.amazon.com/elasticbeanstalk) allows you to deploy your applications directly to Amazon EC2 instances. ## Specify your AWS credentials -To deploy to your AWS account, continuousphp needs an IAM key and secret. You can specify them in the 1st step of the project +To deploy to your AWS account, continuousphp needs access keys for IAM users. You can specify them in the 1st step of the project setup or simply when adding a new pipeline to your existing project. ![AWS IAM credentials](/assets/doc/deployment/aws-elastic-beanstalk/iam-credentials.png) @@ -32,4 +32,4 @@ For more information on how to use AWS Elastic Beanstalk, check out the [documen Make sure that the IAM credentials you provide only have the strict minimum of permissions. Example: The provided IAM credentials shouldn't be able to erase your S3 storage. -And that's it! You just configured your application to be deployed with AWS Elastic Beanstalk. \ No newline at end of file +And that's it! You just configured your application to be deployed with AWS Elastic Beanstalk. diff --git a/mkdocs.yml b/mkdocs.yml index 94e8fc0..c90784e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -78,6 +78,7 @@ nav: - Generic tarball: deployment/generic-tarball.md - Script deployment: deployment/script.md - AWS CodeDeploy: deployment/aws-code-deploy.md + - AWS ECR: deployment/aws-ecr.md - AWS Elastic Beanstalk: deployment/aws-elastic-beanstalk.md - Zend Server: deployment/zend-server.md - Reference guide: