Skip to content

Commit d1e81b1

Browse files
author
Matthew Fisher
committed
ref(docs): add installation docs for deisctl
1 parent 5aac5a0 commit d1e81b1

4 files changed

Lines changed: 78 additions & 67 deletions

File tree

‎deisctl/README.md‎

Lines changed: 2 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -4,51 +4,8 @@
44

55
## Installation
66

7-
### Latest deisctl
8-
9-
To install the latest `deisctl` on Linux or Mac OS X, run this command:
10-
11-
```console
12-
$ curl -sSL http://deis.io/deisctl/install.sh | sh
13-
```
14-
15-
The installer puts `deisctl` in your current directory and downloads current Deis unit files
16-
to *$HOME/.deis/units* one time. You should move `deisctl` somewhere in your $PATH.
17-
18-
To change installation options, save the installer directly from one of these links:
19-
20-
[![Download for Linux](http://img.shields.io/badge/download-Linux-brightgreen.svg?style=flat)](https://s3-us-west-2.amazonaws.com/opdemand/deisctl-0.15.0-dev-linux-amd64.run)
21-
[![Download for Mac OS X](http://img.shields.io/badge/download-Mac%20OS%20X-brightgreen.svg?style=flat)](https://s3-us-west-2.amazonaws.com/opdemand/deisctl-0.15.0-dev-darwin-amd64.run)
22-
23-
Then run the downloaded file as a shell script. Append `--help` to see what options
24-
are available.
25-
26-
### Builds for a specific Deis release
27-
28-
Note that this script will always give you the most freshly-built deisctl off master. If you are
29-
using a specific Deis release (not latest), you'll want to use the deisctl built for your release.
30-
31-
Builds are hosted on an S3 bucket at this URL format: `https://s3-us-west-2.amazonaws.com/opdemand/deisctl-<VERSION>-<darwin|linux>-amd64.run`
32-
33-
The deisctl release for Deis version 0.15.0 can be downloaded here: [Mac OS X](https://s3-us-west-2.amazonaws.com/opdemand/deisctl-0.15.0-darwin-amd64.run) | [Linux](https://s3-us-west-2.amazonaws.com/opdemand/deisctl-0.15.0-linux-amd64.run)
34-
35-
### Building from source
36-
37-
If you want to install from source, ensure you have [https://github.com/tools/godep](godep) installed, clone the repository and run
38-
39-
```console
40-
$ godep get .
41-
```
42-
43-
Then, export the `DEISCTL_UNITS` environment variable so deisctl can find the units:
44-
45-
```console
46-
$ export DEISCTL_UNITS="$PATH_TO_DEISCTL/units"
47-
```
48-
49-
This is also useful for specifying custom behavior on Deis units, such as using
50-
fleet metadata to lock the builder to a more powerful node, or keep application
51-
nodes free of control plane elements.
7+
Please refer to the installation docs at
8+
http://docs.deis.io/en/latest/managing_deis/install_deisctl/.
529

5310
## Remote Configuration
5411

‎docs/installing_deis/digitalocean.rst‎

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -114,32 +114,12 @@ For convenience, you can also set up DNS records for each node:
114114
If you need help using the DNS control panel, check out `this tutorial`_ on DigitalOcean's
115115
community site.
116116

117-
If you're using your own third-party DNS registrar, please refer to their documentation on this
118-
setup, along with the :ref:`dns_records` required.
119-
120-
If you don't have an available domain for testing, you can refer to the :ref:`xip_io` documentation on
121-
setting up a wildcard DNS for Deis.
122-
123117
Install Deis Control Utility
124118
----------------------------
125119

126120
Now that we have the CoreOS cluster set up, we will install the Deis Control Utility. This client
127-
will help us configure and install the platform on top of our CoreOS cluster.
128-
129-
Change to the directory where you would like to install the deisctl binary. Then, install the Deis
130-
Control Utility by downloading and running the install script with the following command:
131-
132-
.. code-block:: console
133-
134-
$ cd ~/bin
135-
$ curl -sSL http://deis.io/deisctl/install.sh | sh -s 0.14.1
136-
137-
This installs deisctl to the current directory, and refreshes the Deis systemd unit files used to
138-
schedule the components. Let's link it to /usr/local/bin, so it will be in our PATH:
139-
140-
.. code-block:: console
141-
142-
$ sudo ln -fs $PWD/deisctl /usr/local/bin/deisctl
121+
will help us configure and install the platform on top of our CoreOS cluster. Please see
122+
:ref:`install_deisctl` for instructions.
143123

144124
Install Deis Platform
145125
---------------------

‎docs/managing_deis/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Managing Deis
1111

1212
.. toctree::
1313

14+
install-deisctl
1415
add_remove_host
1516
backing_up_data
1617
builder_settings

‎docs/managing_deis/install-deisctl.rst‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
:title: Installing the Deis Control Utility
2+
:description: Learn how to install the Deis Control Utility
3+
4+
.. _install_deisctl:
5+
6+
Installing the Deis Control Utility
7+
===================================
8+
9+
The Deis Control Utility, or ``deisctl`` for short, is a command-line client used to configure and
10+
manage the Deis Platform.
11+
12+
Building from Installer
13+
-----------------------
14+
15+
To install the latest version of deisctl, change to the directory where you would like to install
16+
the binary. Then, install the Deis Control Utility by downloading and running the install script
17+
with the following command:
18+
19+
.. code-block:: console
20+
21+
$ cd ~/bin
22+
$ curl -sSL http://deis.io/deisctl/install.sh | sh -s 0.14.1
23+
24+
This installs deisctl to the current directory, and refreshes the Deis systemd unit files used to
25+
schedule the components. Link it to /usr/local/bin, so it will be in your PATH:
26+
27+
.. code-block:: console
28+
29+
$ sudo ln -fs $PWD/deisctl /usr/local/bin/deisctl
30+
31+
To change installation options, save the installer directly:
32+
33+
.. image:: http://img.shields.io/badge/download-Linux-brightgreen.svg?style=flat
34+
:target: https://s3-us-west-2.amazonaws.com/opdemand/deisctl-0.14.1-dev-linux-amd64.run
35+
36+
.. image:: http://img.shields.io/badge/download-Mac%20OS%20X-brightgreen.svg?style=flat
37+
:target: https://s3-us-west-2.amazonaws.com/opdemand/deisctl-0.14.1-dev-darwin-amd64.run
38+
39+
Then run the downloaded file as a shell script. Append ``--help`` to see what options
40+
are available.
41+
42+
If you are using a specific Deis release (not latest), you'll want to use the deisctl built for
43+
your release.
44+
45+
Builds are hosted on an S3 bucket at this URL format:
46+
47+
``https://s3-us-west-2.amazonaws.com/opdemand/deisctl-<VERSION>-<darwin|linux>-amd64.run``
48+
49+
For example, the deisctl release for Deis version 0.14.1 can be downloaded here:
50+
51+
.. image:: http://img.shields.io/badge/download-Linux-brightgreen.svg?style=flat
52+
:target: https://s3-us-west-2.amazonaws.com/opdemand/deisctl-0.14.1-dev-linux-amd64.run
53+
54+
.. image:: http://img.shields.io/badge/download-Mac%20OS%20X-brightgreen.svg?style=flat
55+
:target: https://s3-us-west-2.amazonaws.com/opdemand/deisctl-0.14.1-dev-darwin-amd64.run
56+
57+
Building from Source
58+
--------------------
59+
60+
If you want to install from source, ensure you have `godep`_ installed and run:
61+
62+
.. code-block:: console
63+
64+
$ make -C deisctl build
65+
66+
You can then move or link the client so it will be in your path:
67+
68+
.. code-block:: console
69+
70+
$ sudo ln -fs $PWD/deisctl/deisctl /usr/local/bin/deisctl
71+
72+
73+
.. _`godep`: https://github.com/tools/godep

0 commit comments

Comments
 (0)