Merge pull request Capgemini#667 from Capgemini/gitbook

Add files necessary to enable docs as a gitbook

.gitignore

@@ -22,3 +22,4 @@ roles/coreos_bootstrap
 roles/coreos_timezone
 roles/datadog
 terraform/aws/public-cloud/etcd_discovery_url.txt
+/_book/

README.md

@@ -16,7 +16,6 @@ and scaling of infrastructure and applications.
 
 Apollo is built on top of the following components:
 
-* [Packer](https://packer.io) for automating the build of the base images
 * [Terraform](https://www.terraform.io/) for provisioning the infrastructure
 * [Apache Mesos](http://mesos.apache.org/) for cluster management, scheduling and resource isolation
 * [Consul](http://consul.io) for service discovery, DNS

book.json

@@ -0,0 +1,16 @@
+{
+  "gitbook": "2.4.3",
+  "structure": {
+    "summary": "docs/README.md"
+  },
+  "plugins": ["edit-link", "-search", "github"],
+  "pluginsConfig": {
+    "edit-link": {
+      "base": "https://github.com/Capgemini/apollo/tree/master",
+      "label": "Edit This Page"
+    },
+    "github": {
+      "url": "https://github.com/Capgemini/apollo/"
+    }
+  }
+}

docs/README.md

@@ -0,0 +1,26 @@
+## Table of Contents
+
+* [Read Me](/README.md)
+* [Components](/docs/components/README.md)
+  * [Ansible](/docs/components/ansible.md)
+  * [Apache Mesos](/docs/components/apache-mesos.md)
+  * [Consul](/docs/components/consul.md)
+  * [Docker](/docs/components/docker.md)
+  * [Terraform](/docs/components/terraform.md)
+  * [Vault](/docs/components/vault.md)
+  * [Weave](/docs/components/weave.md)
+* [Getting Started Guides](/docs/getting-started-guides/README.md)
+  * [AWS VPC](/docs/getting-started-guides/aws.md)
+    * [Setting up a VPN connection](/docs/getting-started-guides/aws/vpn.md)
+  * [AWS Public](/docs/getting-started-guides/aws-public.md)
+  * [DigitalOcean](/docs/getting-started-guides/digitalocean.md)
+  * [Google Compute Engine](/docs/getting-started-guides/gce.md)
+  * [Vagrant](/docs/getting-started-guides/vagrant.md)
+* [Examples](/docs/examples/README.md)
+* [Troubleshooting](/docs/Troubleshooting.md)
+* [Networking](/docs/networking.md)
+* [DNS](/docs/dns.md)
+* [Rolling Upgrades](/docs/platform-rolling-upgrades.md)
+* [Contributing](/CONTRIBUTING.md)
+* [Change Log](/CHANGELOG.md)
+* [Roadmap](/docs/roadmap.md)

docs/getting-started-guides/digitalocean.md

@@ -3,7 +3,6 @@
 ### Prerequisites
 
 1. You need an Digital Ocean account. Visit [https://cloud.digitalocean.com/registrations/new](https://cloud.digitalocean.com/registrations/new) to get started
-2. You need an Atlas account. Visit [https://atlas.hashicorp.com](https://atlas.hashicorp.com) to get started.
 4. You need to have installed and configured Terraform (>= 0.5.0 recommended). Visit [https://www.terraform.io/intro/getting-started/install.html](https://www.terraform.io/intro/getting-started/install.html) to get started.
 4. You need to have [Packer](https://www.packer.io) installed.
 5. You need to have [Python](https://www.python.org/) >= 2.7.5 installed along with [pip](https://pip.pypa.io/en/latest/installing.html).
@@ -19,22 +18,6 @@ droplets. Execute `ssh-keygen -t rsa` to create a key pair.
 2. `cd apollo`
 3. `pip install -r requirements.txt`
 
-#### Build the base image in Atlas
-
-We are using [Atlas](https://atlas.hashicorp.com) to store artifacts (images) for
-builds.
-
-You will need to push and build your Atlas artifact (via Packer in the Atlas cloud) in order to
-provision your nodes via terraform. See the [guide on how to build artifacts in Atlas](../../docs/atlas.md)
-
-When using `atlas_artifact` in Terraform, Terraform is looking up the Atlas artifact to retrieve the Digitalocean image ID to replace it in the `image` field. If you need to debug to see which images are available under your Digitalocean account you can run the following from your terminal -
-
-```
-curl -X GET -H 'Content-Type: application/json' -H 'Authorization: Bearer $DIGITALOCEAN_API_TOKEN' "https://api.digitalocean.com/v2/images?page=1&per_page=1&private=true"
-```
-
-replacing `$DIGITALOCEAN_API_TOKEN` with your v2 API token.
-
 #### Set config
 
 Configuration can be set via environment variables.
@@ -61,16 +44,6 @@ APOLLO_PROVIDER=digitalocean
 
 # Path to your public ssh key (created in prerequisite step 6 above).
 TF_VAR_key_file=
-
-# Atlas variables.
-ATLAS_TOKEN=
-ATLAS_INFRASTRUCTURE=
-
-TF_VAR_altas_artifact_master=
-TF_VAR_atlas_artifact_slave=
-TF_VAR_altas_artifact_version_master=
-TF_VAR_atlas_artifact_version_slave=
-
 ```
 
 #### Start up the cluster

docs/roadmap.md

@@ -28,16 +28,16 @@ Providers
 
 Operating Systems
 -----------------
-- [x] Ubuntu
+- [ ] Ubuntu
 - [ ] CentOS
 - [ ] Fedora
-- [ ] CoreOS
+- [x] CoreOS
 
 Features
 --------
 - [x] Easier pluggability for frameworks
-- [ ] Move all services to Docker containers
-- [ ] Monitoring and alerts(nodes/services)
+- [x] Move all services to Docker containers
+- [x] Monitoring and alerts(nodes/services)
 - [ ] Logging (nodes/services)
 - [ ] Metrics (nodes/services)
 - [ ] Distributed File storage (for nodes/services)

package.json

@@ -0,0 +1,33 @@
+{
+  "name": "apollo",
+  "private": true,
+  "version": "0.0.1",
+  "description": "An open-source PaaS for cloud native applications",
+  "scripts": {
+    "docs:prepare": "gitbook install",
+    "docs:build": "npm run docs:prepare && gitbook build -g capgemini/apollo",
+    "docs:watch": "npm run docs:prepare && gitbook serve",
+    "docs:publish": "npm run docs:clean && npm run docs:build && cp CNAME _book && cd _book && git init && git commit --allow-empty -m 'update book' && git checkout -b gh-pages && touch .nojekyll && git add . && git commit -am 'update book' && git push [email protected]:capgemini/apollo gh-pages --force"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/capgemini/apollo.git"
+  },
+  "keywords": [
+    "capgemini",
+    "apollo",
+    "mesos",
+    "docker",
+    "paas",
+    "containers"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/capgemini/apollo/issues"
+  },
+  "homepage": "https://github.com/capgemini/apollo/issues",
+  "dependencies": {},
+  "devDependencies": {
+    "gitbook-cli": "^0.3.4"
+  }
+}