Skip to content

Commit c72e970

Browse files
committed
Created provider-specific installation docs, refs #227.
1 parent 358d36b commit c72e970

29 files changed

Lines changed: 473 additions & 336 deletions

README.md

Lines changed: 9 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -33,144 +33,22 @@ Free, transparent and easily customized. Join the open-source PaaS and DevOps co
3333

3434
## Getting Started
3535

36-
Before you get started, read about Deis core [concepts](http://docs.deis.io/en/latest/gettingstarted/concepts/) so you can answer:
36+
First read about Deis core [concepts](http://docs.deis.io/en/latest/gettingstarted/concepts/) so you can answer:
3737

3838
* What is a [Formation](http://docs.deis.io/en/latest/gettingstarted/concepts/#formations) and how does it relate to an application?
3939
* What are [Layers and Nodes](http://docs.deis.io/en/latest/gettingstarted/concepts/#layers), and how do they work with Chef?
4040
* How does the [Build, Release, Run](http://docs.deis.io/en/latest/gettingstarted/concepts/#build-release-run) process work?
4141
* How do I connect an application to [backing services](http://docs.deis.io/en/latest/gettingstarted/concepts/#backing-services)?
4242

43-
Follow the steps below to install your own Deis platform on EC2. To complete the installation process, you will need [Git](http://git-scm.com), [RubyGems](http://rubygems.org/pages/download), [Pip](http://www.pip-installer.org/en/latest/installing.html), the [Amazon EC2 API Tools](http://aws.amazon.com/developertools/351), [EC2 Credentials](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/SettingUp_CommandLine.html#set_aws_credentials_linux) and a Chef Server with a working [Knife](http://docs.opscode.com/knife.html) client.
43+
Next, choose which cloud provider should host your Deis controller.
44+
Regardless of whether your controller is hosted with
45+
[Amazon EC2](http://docs.deis.io/en/latest/installation/ec2/),
46+
[Rackspace](http://docs.deis.io/en/latest/installation/rackspace/), or
47+
[DigitalOcean](http://docs.deis.io/en/latest/installation/digitalocean/),
48+
it can create and manage nodes on any of those cloud providers.
4449

45-
*Please note: Deis is still under active development. It should not yet be used in production.*
46-
47-
### 1. Clone the Deis Repository
48-
49-
```bash
50-
$ git clone https://github.com/opdemand/deis.git
51-
$ cd deis
52-
```
53-
54-
Cloning the default master branch will provide you with the latest development version of Deis. If you want to deploy the latest stable release, make sure you checkout the most recent tag using ``git checkout vX.Y.Z``.
55-
56-
### 2. Configure the Chef Server
57-
58-
Deis requires a Chef Server. [Sign up for a free Hosted Chef account](https://getchef.opscode.com/signup) if you don’t have one. You’ll also need a Ruby runtime with RubyGems in order to install the required Ruby dependencies.
59-
60-
```bash
61-
$ bundle install # install ruby dependencies
62-
$ berks install # install cookbooks into your local berkshelf
63-
$ berks upload # upload cookbooks to the chef server
64-
```
65-
66-
### 3. Provision a Deis Controller
67-
68-
The [Amazon EC2 API Tools](http://aws.amazon.com/developertools/351) will be used to setup basic EC2 infrastructure. The [Knife EC2 plugin](https://github.com/opscode/knife-ec2) will be used to bootstrap the controller.
69-
70-
$ contrib/ec2/provision-ec2-controller.sh
71-
72-
Once the `deis-controller` node exists on the Chef server, you *must* log in to the WebUI add deis-controller to the `admins` group. This is required so the controller can delete node and client records during future scaling operations.
73-
74-
### 4. Install the Deis Client
75-
76-
Install the Deis client using [Pip](http://www.pip-installer.org/en/latest/installing.html) (for latest stable) or by linking `<repo>/client/deis.py` to `/usr/local/bin/deis` (for dev version). Registration will discover SSH keys automatically and use the [standard environment variables](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/SettingUp_CommandLine.html#set_aws_credentials_linux) to configure the EC2 provider.
77-
78-
```bash
79-
$ sudo pip install deis
80-
$ deis register http://my-deis-controller.fqdn
81-
username: myuser
82-
password:
83-
password (confirm):
84-
email: myuser@example.com
85-
Registered myuser
86-
Logged in as myuser
87-
88-
Found the following SSH public keys:
89-
1) id_rsa.pub
90-
Which would you like to use with Deis? 1
91-
Uploading /Users/myuser/.ssh/id_rsa.pub to Deis... done
92-
93-
Found EC2 credentials: AKIAJTVXXXXXXXXXXXXX
94-
Import these credentials? (y/n) : y
95-
Uploading EC2 credentials... done
96-
```
97-
98-
### 5. Create & Scale a Formation
99-
100-
Use the Deis client to create a new formation named "dev" that
101-
has a default layer that serves as both runtime (hosts containers)
102-
and proxy (routes traffic to containers). Scale the default layer
103-
up to one node.
104-
105-
```bash
106-
$ deis formations:create dev --flavor=ec2-us-west-2 --domain=deisapp.com
107-
Creating formation... done, created dev
108-
Creating runtime layer... done in 1s
109-
110-
Use `deis nodes:scale dev runtime=1` to scale a basic formation
111-
112-
$ deis nodes:scale dev runtime=1
113-
Scaling nodes... but first, coffee!
114-
...done in 251s
115-
116-
Use `deis create --formation=dev` to create an application
117-
```
118-
119-
### 6. Deploy & Scale an Application
120-
121-
Change into your application directory and use ``deis create --formation=dev``
122-
to create a new application attached to the dev formation.
123-
124-
To deploy the application, use `git push deis master`. Deis will automatically deploy Docker containers and configure Nginx proxies to route requests to your application.
125-
126-
Once your application is deployed, use ``deis scale web=4`` to
127-
scale up web containers. You can also use ``deis logs`` to view
128-
aggregated application logs, or ``deis run`` to run admin
129-
commands inside your application.
130-
131-
To learn more, use `deis help` or browse [the documentation](http://docs.deis.io).
132-
133-
```bash
134-
$ deis create --formation=dev
135-
Creating application... done, created peachy-waxworks
136-
Git remote deis added
137-
138-
$ git push deis master
139-
Counting objects: 146, done.
140-
Delta compression using up to 8 threads.
141-
Compressing objects: 100% (122/122), done.
142-
Writing objects: 100% (146/146), 21.54 KiB, done.
143-
Total 146 (delta 84), reused 47 (delta 22)
144-
Node.js app detected
145-
-----> Resolving engine versions
146-
Using Node.js version: 0.10.15
147-
Using npm version: 1.2.30
148-
...
149-
-----> Building runtime environment
150-
-----> Discovering process types
151-
Procfile declares types -> web
152-
153-
-----> Compiled slug size: 4.7 MB
154-
Launching... done, v2
155-
156-
-----> peachy-waxworks deployed to Deis
157-
http://peachy-waxworks.deisapp.com ...
158-
159-
$ curl -s http://peachy-waxworks.deisapp.com
160-
Powered by Deis!
161-
162-
$ deis scale web=4
163-
Scaling containers... but first, coffee!
164-
done in 12s
165-
166-
=== peachy-waxworks Containers
167-
168-
--- web: `node server.js`
169-
web.1 up 2013-09-23T19:02:30.745Z (dev-runtime-1)
170-
web.2 up 2013-09-23T19:36:48.741Z (dev-runtime-1)
171-
web.3 up 2013-09-23T19:36:48.758Z (dev-runtime-1)
172-
web.4 up 2013-09-23T19:36:48.771Z (dev-runtime-1)
173-
```
50+
Proceed to the [Installation](http://docs.deis.io/en/latest/installation/)
51+
documentation to start building your own private PaaS.
17452

17553
## Credits
17654

client/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ to route requests to your application.
147147
148148
To learn more, use `deis help` or visit http://deis.io
149149
150-
To git@deis.mattboersma.com:nimbus-pamphlet.git
150+
To git@198.51.100.22:nimbus-pamphlet.git
151151
* [new branch] master -> master
152152
153153
$ curl -s http://ec2-198.51.100.22.us-west-2.compute.amazonaws.com

docs/contributing/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,5 @@ Contributing
1616
standards
1717
community
1818
conduct
19+
releases
1920

File renamed without changes.

docs/gettingstarted/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,5 @@ Getting Started
1111
:maxdepth: 1
1212

1313
concepts
14-
installation
15-
usage
16-
tutorial
14+
terms/index
15+
usage

docs/gettingstarted/installation.rst

Lines changed: 0 additions & 198 deletions
This file was deleted.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)