Skip to content

Commit a8e19d3

Browse files
committed
Updated README.rst for Deis CLI, fixes #409.
1 parent 17da691 commit a8e19d3

1 file changed

Lines changed: 37 additions & 76 deletions

File tree

client/README.rst

Lines changed: 37 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ Deis controller, providing a Heroku-inspired PaaS workflow.
99
.. image:: https://travis-ci.org/opdemand/deis.png?branch=master
1010
:target: https://travis-ci.org/opdemand/deis
1111

12-
.. image:: https://pypip.in/d/deis/badge.png
13-
:target: https://crate.io/packages/deis/
14-
1512
What is Deis?
1613
-------------
1714

@@ -61,104 +58,68 @@ and DevOps community by using Deis and complimentary projects like
6158
Docker, Chef and Heroku Buildpacks.
6259

6360

64-
Getting Started
65-
---------------
66-
67-
Installing the Deis client using `pip`_ is simple::
68-
69-
$ pip install deis
70-
71-
`pip`_ will automatically install the following dependencies:
72-
73-
- `docopt <http://docopt.org>`__
74-
- `pyyaml <https://bitbucket.org/xi/pyyaml>`__
75-
- `requests <http://python-requests.org>`__
76-
77-
You should know the fully-qualified domain name of an existing
78-
Deis controller. To set up a Deis controller, see the
79-
`Installation`_ documentation.
61+
Get Started
62+
===========
8063

81-
Registration will discover SSH keys automatically and use environment variables
82-
to configure Amazon EC2, Rackspace, and DigitalOcean providers.
64+
1. `Install the Client`_:
8365

8466
.. code-block:: console
8567
86-
$ deis register http://my-deis-controller.fqdn
87-
username: myuser
88-
password:
89-
password (confirm):
90-
email: myuser@example.com
91-
Registered myuser
92-
Logged in as myuser
68+
$ sudo pip install deis
9369
94-
Found the following SSH public keys:
95-
1) id_rsa.pub
96-
Which would you like to use with Deis? 1
97-
Uploading /Users/myuser/.ssh/id_rsa.pub to Deis... done
9870
99-
Find an application you’d like to deploy, or clone `an example app`_.
100-
101-
Change into the application directory and use ``deis formations:create`` to
102-
initialize a new formation in a specific cloud region. For example:
71+
2. `Register a User`_:
10372

10473
.. code-block:: console
10574
106-
$ deis formations:create dev1 --flavor=rackspace-dfw
75+
$ deis register http://deis.example.com
76+
$ deis keys:add
10777
108-
Use the ``deis nodes:scale`` command to provision nodes that will be
109-
dedicated to this formation.
11078
111-
Then create an application that references the formation.
79+
3. `Deploy an Application`_:
11280

11381
.. code-block:: console
11482
115-
$ cd <my-application-repo>
116-
$ deis create --formation=dev1
117-
Creating application... done, created nimbus-pamphlet
83+
$ deis create
84+
Creating application... done, created peachy-waxworks
11885
Git remote deis added
86+
$ git push deis master
87+
Java app detected
88+
-----> Installing OpenJDK 1.6... done
89+
...
90+
-----> Compiled slug size: 63.5 MB
91+
Launching... done, v2
11992
120-
Use ``git push deis master`` to deploy your application.
121-
122-
Deis will automatically deploy Docker containers and configure Nginx proxies
123-
to route requests to your application.
93+
-----> peachy-waxworks deployed to Deis
94+
http://peachy-waxworks.example.com ...
12495
125-
.. code-block:: console
96+
$ curl -s http://peachy-waxworks.example.com
97+
Powered by Deis!
12698
127-
(deis)flopsy:example-go matt$ git push deis master
128-
Counting objects: 13, done.
129-
Delta compression using up to 8 threads.
130-
Compressing objects: 100% (11/11), done.
131-
Writing objects: 100% (13/13), 6.20 KiB | 0 bytes/s, done.
132-
Total 13 (delta 2), reused 0 (delta 0)
133-
Go app detected
134-
-----> Installing Go 1.1.2... done
135-
Installing Virtualenv... done
136-
Installing Mercurial... done
137-
Installing Bazaar... done
138-
-----> Running: go get -tags heroku ./...
139-
-----> Discovering process types
140-
Procfile declares types -> web
141-
142-
-----> Compiled slug size: 1.2 MB
143-
Launching... done, v2
14499
145-
-----> nimbus-pamphlet deployed to Deis
146-
http://ec2-198.51.100.22.us-west-2.compute.amazonaws.com
100+
4. `Manage an Application`_:
147101

148-
To learn more, use `deis help` or visit http://deis.io
102+
.. code-block:: console
149103
150-
To git@198.51.100.22:nimbus-pamphlet.git
151-
* [new branch] master -> master
104+
$ deis config:set DATABASE_URL=postgres://user:pass@example.com:5432/db
105+
$ deis scale web=8
106+
$ deis run ls -l # the view from inside a container
107+
total 28
108+
-rw-r--r-- 1 root root 553 Dec 2 23:59 LICENSE
109+
-rw-r--r-- 1 root root 60 Dec 2 23:59 Procfile
110+
-rw-r--r-- 1 root root 33 Dec 2 23:59 README.md
111+
-rw-r--r-- 1 root root 1622 Dec 2 23:59 pom.xml
112+
drwxr-xr-x 3 root root 4096 Dec 2 23:59 src
113+
-rw-r--r-- 1 root root 25 Dec 2 23:59 system.properties
114+
drwxr-xr-x 6 root root 4096 Dec 3 00:00 target
152115
153-
$ curl -s http://ec2-198.51.100.22.us-west-2.compute.amazonaws.com
154-
Powered by Deis!
155116
156117
To learn more, use ``deis help`` or browse `the documentation`_.
157118

158-
.. _`pip`: http://www.pip-installer.org/en/latest/installing.html
159-
.. _`Installation`: http://docs.deis.io/en/latest/gettingstarted/installation/
160-
.. _`standard environment variables`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/SettingUp_CommandLine.html#set_aws_credentials_linux
161-
.. _`an example app`: https://github.com/opdemand/example-nodejs-express
119+
.. _`Install the Client`: http://docs.deis.io/en/latest/developer/install-client/
120+
.. _`Register a User`: http://docs.deis.io/en/latest/developer/register-user/
121+
.. _`Deploy an Application`: http://docs.deis.io/en/latest/developer/deploy-application/
122+
.. _`Manage an Application`: http://docs.deis.io/en/latest/developer/manage-application/
162123
.. _`the documentation`: http://docs.deis.io/
163124

164125

0 commit comments

Comments
 (0)