diff --git a/README.md b/README.md index ba6e9c98d..fad3c5dfc 100644 --- a/README.md +++ b/README.md @@ -2,74 +2,28 @@ # The DevOps Platform: Overview -The DevOps Platform is a tools environment for continuously testing, releasing and maintaining applications. Reference code, delivery pipelines, automated testing and environments can be loaded in via the concept of Cartridges. +The DevOps Platform is a tools environment for continuously testing, releasing and maintaining applications. Reference code, delivery pipelines, automated testing and environments can be loaded in via the concept of [Cartridges](https://github.com/Accenture/adop-cartridge-skeleton). -![HomePage](https://raw.githubusercontent.com/accenture/adop-docker-compose/master/img/home.png) - -Once you have a stack up and running, please log in with the username and password created upon startup. +The platform runs on a [docker container cluster](https://docs.docker.com/swarm/) so it can be stood up for evaluation purposes on just one server using local storage, or stood up in a multi-data centre cluster with distributed network storage. It will also run anywhere that [docker runs](https://docs.docker.com/engine/installation/binaries/). -# Quickstart Instructions +Here is the front page: -These instructions will spin up an instance in a single server in AWS (for evaluation purposes). +![HomePage](https://raw.githubusercontent.com/accenture/adop-docker-compose/master/img/home.png) -1. Create a VPC using the [VPC wizard](http://docs.aws.amazon.com/AmazonVPC/latest/GettingStartedGuide/getting-started-create-vpc.html) in the AWS console by selecting the first option with 1 public subnet. -1. On the "Step 2: VPC with a Single Public Subnet" page give your VPC a meaningful name and specify the availability zone as 'a', e.g. select eu-west-1a from the pulldown. -1. Once the VPC is created note the VPC ID (e.g. vpc-1ed3sfgw) -1. Clone this repository and then in a terminal window (this has been tested in GitBash) run: -```bash -$ ./startup.sh -Usage: ./startup.sh -m - -c - -z (optional) - -r (optional) - -a (optional) - -s (optional) - -v (optional) - -n (optional) - -l LOGGING_DRIVER(optional) - -f path/to/additional_override1.yml(optional) - -f path/to/additional_override2.yml(optional) - -u - -p (optional) ... -``` -* You will need to supply: - - a machine name (anything you want) - - the target VPC - - If you don't have your AWS credentials and default region [stored locally in ~/.aws](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-config-files) you will also need to supply: - - your AWS key and your secret access key (see [getting your AWS access key](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/AWSCredentials.html)) via command line options, environment variables or using aws configure - - the AWS region id in this format: eu-west-1 - - a username and password (optional) to act as credentials for the initial admin user (you will be prompted to re-enter your password if it is considered weak) - -For example (if you don't have ~/.aws set up) -```bash -./startup.sh -m adop1 -a AAA -s BBB -c vpc-123abc -r eu-west-1 -u userName -p userPassword -``` -N.B. If you see an error saying that docker-machine cannot find an associated subnet in a zone, go back to the VPC Dashboard on AWS and check the availablity zone for the subnet you've created. Then rerun the startup script and use the -z option to specify the zone for your subnet, e.g. for a zone of eu-west-1c the above command becomes -```bash -./startup.sh -m adop1 -a AAA -s BBB -c vpc-123abc -r eu-west-1 -u user.name -p userPassword -z c -``` -1. If all goes well you will see the following output and you can view the DevOps Platform in your browser -```bash -########################################################## +Once you have a stack up and running, you can log in with the username and password created upon start-up. -SUCCESS, your new ADOP instance is ready! +If you provisioned your stack using the start-up CLI, an example workspace containing an example project and an example cartridge will all have been pre-loaded in Jenkins: -Run these commands in your shell: - eval \"$(docker-machine env $MACHINE_NAME)\" - source credentials.generate.sh - source env.config.sh +![HomePage](https://raw.githubusercontent.com/Accenture/adop-docker-compose/master/img/exampleproj.png) -Navigate to http://11.22.33.44 in your browser to use your new DevOps Platform! -``` -1. Log in using the username and password you created in the startup script: -```sh -/ -``` +Once you have explored this the next step is to create your own Workspace and Project and then load another cartridge using a 'Load Cartridge' job in the 'Cartridge Management' folder (that automatically gets created in any Project). The cartridge [development cartridge](https://github.com/accenture/adop-cartridge-cartridge-dev/) also helps create your own cartridges. -# Quickstart Instructions (Experimental) +# Quickstart Instructions These instructions will spin up an instance in a single server in AWS (for evaluation purposes). +NB. the instructions will also work in anywhere supported by [Docker Machine](https://docs.docker.com/machine/), just follow the relevant Docker Machine instructions for your target platform and then start at step 3 below and (you can set the VPC_ID to NA). + 1. Create a VPC using the [VPC wizard](http://docs.aws.amazon.com/AmazonVPC/latest/GettingStartedGuide/getting-started-create-vpc.html) in the AWS console by selecting the first option with 1 public subnet. 1. On the "Step 2: VPC with a Single Public Subnet" page give your VPC a meaningful name and specify the availability zone as 'a', e.g. select eu-west-1a from the pulldown. 1. Once the VPC is created note the VPC ID (e.g. vpc-1ed3sfgw) @@ -86,8 +40,8 @@ These instructions will spin up an instance in a single server in AWS (for evalu -z (optional) -a (optional) -s (optional) - -u - -p (optional) ... + -u + -p (optional) ... ``` - You will need to supply: - the type of machine to create (aws, in this example) @@ -96,7 +50,7 @@ These instructions will spin up an instance in a single server in AWS (for evalu - If you don't have your AWS credentials and default region [stored locally in ~/.aws](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#cli-config-files) you will also need to supply: - your AWS key and your secret access key (see [getting your AWS access key](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/AWSCredentials.html)) via command line options, environment variables or using aws configure - the AWS region id in this format: eu-west-1 - - a username and password to act as credentials for the initial admin user + - a username and password (optional) to act as credentials for the initial admin user (you will be prompted to re-enter your password if it is considered weak) - For example (if you don't have ~/.aws set up): ```./quickstart.sh -t aws -m adop1 -a AAA -s BBB -c vpc-123abc -r eu-west-1 -u user.name -p userPassword``` @@ -110,10 +64,15 @@ These instructions will spin up an instance in a single server in AWS (for evalu SUCCESS, your new ADOP instance is ready! Run this command in your shell: - source credentials.generate.sh - source env.config.sh + source env.config.sh + source credentials.generate.sh + + You can check if any variables are missing with: ./adop compose config | grep 'WARNING' Navigate to http://11.22.33.44 in your browser to use your new DevOps Platform! + Login using the following credentials: + Username: YOUR_USERNAME + Password: YOUR_PASSWORD ``` 1. Log in using the username and password you specified in the quickstart script: ``` diff --git a/img/exampleproj.png b/img/exampleproj.png new file mode 100644 index 000000000..444daabf2 Binary files /dev/null and b/img/exampleproj.png differ