From 38776d69346bb7c003952235593b226dd1cf9535 Mon Sep 17 00:00:00 2001 From: Luis Sousa Date: Mon, 12 Dec 2016 22:38:26 +0000 Subject: [PATCH] Issue: #174 - add page for adop cli and quickstart Migrate quickstart page from the readme to the site. Added page for using the adop cli. Updated index.md to add link to pre-requisites and list of child pages. --- README.md | 2 +- site/_data/docs.yml | 2 + site/_docs/prerequisites.md | 1 + site/_docs/provisioning/adop_cli.md | 40 +++++++++++++++ site/_docs/provisioning/index.md | 14 +++++- site/_docs/provisioning/quickstart.md | 71 +++++++++++++++++++++++++++ 6 files changed, 128 insertions(+), 2 deletions(-) create mode 100644 site/_docs/provisioning/adop_cli.md create mode 100644 site/_docs/provisioning/quickstart.md diff --git a/README.md b/README.md index 2993530f4..766e0bdcb 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ NB. the instructions will also work in anywhere supported by [Docker Machine](ht 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! + Navigate to http:// in your browser to use your new DevOps Platform! Login using the following credentials: Username: YOUR_USERNAME Password: YOUR_PASSWORD diff --git a/site/_data/docs.yml b/site/_data/docs.yml index 4a64f6925..f10e443b7 100644 --- a/site/_data/docs.yml +++ b/site/_data/docs.yml @@ -18,6 +18,8 @@ - title: Provisioning [WIP] docs: - provisioning + - provisioning/quickstart + - provisioning/adop_cli - title: Operating docs: diff --git a/site/_docs/prerequisites.md b/site/_docs/prerequisites.md index 24263ccdf..59791f48b 100644 --- a/site/_docs/prerequisites.md +++ b/site/_docs/prerequisites.md @@ -19,6 +19,7 @@ To run ADOP in evaluation mode you will need: * Only required for evaluation mode * Docker Machine 0.9.0 + To run ADOP outside of evaluation mode (i.e. using the CLI directly) you will need: * All of the above, except Docker Machine diff --git a/site/_docs/provisioning/adop_cli.md b/site/_docs/provisioning/adop_cli.md new file mode 100644 index 000000000..6822ea3fa --- /dev/null +++ b/site/_docs/provisioning/adop_cli.md @@ -0,0 +1,40 @@ +--- +layout: docs +chapter: Provisioning +title: Using the adop cli +permalink: /docs/provisioning/adop_cli/ +--- + +# ADOP CLI Instructions + +These instructions will spin up an instance in a single server after it has been provisioned by using the ADOP CLI. + +Please check the [prerequisites](http://accenture.github.io/adop-docker-compose/docs/prerequisites/). + +1. Clone the [ADOP git repository](https://github.com/Accenture/adop-docker-compose) and cd into it. +2. Run the ADOP CLI with the added parameter for the Proxy IP. + 1. This IP must be reachable otherwise the startup will hang. +``` +./adop compose -i init +``` +3. If all goes well you will see the following output and you can view the DevOps Platform in your browser + ``` + ########################################################## + + SUCCESS, your new ADOP instance is ready! + + Run this command in your shell: + source credentials.generate.sh + source env.config.sh + + You can check if any variables are missing with: ./adop compose config | grep 'WARNING' + + Navigate to http:// in your browser to use your new DevOps Platform! + Login using the following credentials: + Username: YOUR_USERNAME + Password: YOUR_PASSWORD + ``` +4. Log in using the username and password you specified in the quickstart script: + ``` + / + ``` diff --git a/site/_docs/provisioning/index.md b/site/_docs/provisioning/index.md index cc05c4e54..48f8a022b 100644 --- a/site/_docs/provisioning/index.md +++ b/site/_docs/provisioning/index.md @@ -5,4 +5,16 @@ title: Getting Started permalink: /docs/provisioning/ --- -Coming soon. +This is the home of all Provisioning documentation. + +If you are new to the platform then the recommended reading is: + +- [Prerequisites](/adop-docker-compose/docs/prerequisites/) +- [Quickstart](/adop-docker-compose/docs/quickstart/) +- [Architecture Overview](/adop-docker-compose/docs/architecture/) + + +Most common provisioning scenarios: + +- [Using the quickstart script](/adop-docker-compose/docs/provisioning/quickstart.md) +- [Using the adop cli](/adop-docker-compose/docs/provisioning/adop_cli) \ No newline at end of file diff --git a/site/_docs/provisioning/quickstart.md b/site/_docs/provisioning/quickstart.md new file mode 100644 index 000000000..ae1611497 --- /dev/null +++ b/site/_docs/provisioning/quickstart.md @@ -0,0 +1,71 @@ +--- +layout: docs +chapter: Provisioning +title: Using the quickstart script +permalink: /docs/provisioning/quickstart +--- + +# Quickstart Instructions + +These instructions will spin up an instance in a single server in AWS (for evaluation purposes). Please check the [prerequisites](http://accenture.github.io/adop-docker-compose/docs/prerequisites/). + +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 AWS_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. +2. 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. +3. Once the VPC is created note the VPC ID (e.g. vpc-1ed3sfgw) +4. Clone this repository and then in a terminal window (this has been tested in GitBash): + - Run: + + ```./quickstart.sh ``` + ```bash + $ ./quickstart.sh + Usage: ./quickstart.sh -t aws + -m + -c + -r + -z (optional) + -a (optional) + -s (optional) + -u + -p (optional) ... + ``` + - You will need to supply: + - the type of machine to create (aws, in this example) + - 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) + - The initial admin username cannot be set to 'admin' to avoid duplicate entries in LDAP. + - AWS parameters i.e. a subnet ID, the name of a keypair and an EC2 instance type (these parameters are useful if you would like to extend the platform with additional AWS EC2 services) + - 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``` + - 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: + + ```./quickstart.sh -t aws -m adop1 -a AAA -s BBB -c vpc-123abc -r eu-west-1 -u user.name -p userPassword -z c``` +5. If all goes well you will see the following output and you can view the DevOps Platform in your browser + ``` + ########################################################## + + SUCCESS, your new ADOP instance is ready! + + Run this command in your shell: + source ./conf/env.provider.sh + source credentials.generate.sh + source env.config.sh + + You can check if any variables are missing with: ./adop compose config | grep 'WARNING' + + Navigate to http:// in your browser to use your new DevOps Platform! + Login using the following credentials: + Username: YOUR_USERNAME + Password: YOUR_PASSWORD + ``` +6. Log in using the username and password you specified in the quickstart script: + ``` / ``` + +7. Update the docker-machine security group in the AWS console to permit inbound http traffic on port 80 (from the machine(s) from which you want to have access only), also UDP on 25826 and 12201 from 127.0.0.1/32. +