Skip to content

Commit

Permalink
docs(*): set required platform config before install/start
Browse files Browse the repository at this point in the history
  • Loading branch information
Gabriel Monroy committed Oct 23, 2014
1 parent e986794 commit 78518c0
Show file tree
Hide file tree
Showing 7 changed files with 76 additions and 76 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,22 @@ This instructs Vagrant to spin up 3 VMs. To be able to connect to the VMs, you m
$ ssh-add ~/.vagrant.d/insecure_private_key
```

## Configure Deis

Before Deis will start successfully, there are a few administrative settings we need to provide.

Set the default domain used to anchor your applications. For a Vagrant environment, use `local3.deisapp.com` as it will resolve to your local routers:

```console
$ deisctl config platform set domain=local3.deisapp.com
```

If you want to allow `deis run` for one-off admin commands, you must provide an SSH private key that allows Deis to gather container logs on CoreOS hosts:

```console
$ deisctl config platform set sshPrivateKey=~/.vagrant.d/insecure_private_key
```

## Provision Deis

Install the [deisctl utility](deisctl#installation) used to provision and operate Deis.
Expand All @@ -75,22 +91,6 @@ This can take some time - the **builder** must download and install the beefy He

Your Deis platform should be accessible at `deis.local3.deisapp.com`. For clusters on other platforms see our guide to [Configuring DNS](http://docs.deis.io/en/latest/installing_deis/configure-dns/).

## Configure Deis

Now that Deis is running there are a few administrative settings we need to provide.

Set the default domain used to anchor your applications. For a Vagrant environment, use `local3.deisapp.com` as it will resolve to your local routers:

```console
$ deisctl config platform set domain=local3.deisapp.com
```

If you want to allow `deis run` for one-off admin commands, you must provide an SSH private key that allows Deis to gather container logs on CoreOS hosts:

```console
$ deisctl config platform set sshPrivateKey=~/.vagrant.d/insecure_private_key
```

## Install the Deis Client

If you're using the latest Deis release, use `pip install --upgrade deis` to install the latest [Deis Client](https://pypi.python.org/pypi/deis/) or download [pre-compiled binaries](https://github.com/deis/deis/tree/master/client#get-started).
Expand Down
18 changes: 9 additions & 9 deletions contrib/bare-metal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,6 @@ and specify that version by appending the `-V` parameter to the install command,

After the installation has finished reboot your server. Once your machine is back up you should be able to log in as the `core` user using the `deis` ssh key.

## Initialize the cluster
Once your server(s) are all provisioned you can proceed to install Deis. Use the hostname of one of your machines in the next step.

```console
$ ssh-add ~/.ssh/deis
$ export DEISCTL_TUNNEL=your.server.name.here
$ deisctl install platform && deisctl start platform
```

## Configure Deis
Set the default domain used to anchor your applications:

Expand All @@ -77,6 +68,15 @@ If you want to allow `deis run` for one-off admin commands, you must provide an
$ deisctl config platform set sshPrivateKey=<path-to-private-key>
```

## Initialize the cluster
Once your server(s) are all provisioned you can proceed to install Deis. Use the hostname of one of your machines in the next step.

```console
$ ssh-add ~/.ssh/deis
$ export DEISCTL_TUNNEL=your.server.name.here
$ deisctl install platform && deisctl start platform
```

## Use Deis!
After that, register with Deis!
```console
Expand Down
18 changes: 9 additions & 9 deletions contrib/digitalocean/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,6 @@ droplet size. The default is 8 GB. Specify the size with NGB, where N is 2, 4, 8

This will print the IP addresses of the initialized machines.

## Initialize the cluster
set DEISCTL_TUNNEL to one of the IPs of the virtual machines (these are printed on the console in a previous step). You can also login to the web interface of DigitalOcean to see the Public IP addresses.

```console
$ export DEISCTL_TUNNEL=23.253.219.94
$ deisctl install platform && deisctl start platform
```
Deisctl will deploy Deis and make sure the services are started properly. Grab a coffee.

## Configure Deis
Set the default domain used to anchor your applications:

Expand All @@ -84,6 +75,15 @@ If you want to allow `deis run` for one-off admin commands, you must provide an
$ deisctl config platform set sshPrivateKey=<path-to-private-key>
```

## Initialize the cluster
set DEISCTL_TUNNEL to one of the IPs of the virtual machines (these are printed on the console in a previous step). You can also login to the web interface of DigitalOcean to see the Public IP addresses.

```console
$ export DEISCTL_TUNNEL=23.253.219.94
$ deisctl install platform && deisctl start platform
```
Deisctl will deploy Deis and make sure the services are started properly. Grab a coffee.

### Use Deis!
After that, register with Deis!
```console
Expand Down
20 changes: 10 additions & 10 deletions contrib/ec2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,16 +112,6 @@ Please wait for all instances to come up as "running" before continuing.
Check the AWS EC2 web control panel and wait until "Status Checks" for all instances have passed.
This will take several minutes.

## Initialize the cluster
Once the cluster is up, get the hostname of any of the machines from EC2, set
DEISCTL_TUNNEL, and issue a `deisctl install`:
```console
$ ssh-add ~/.ssh/deis
$ export DEISCTL_TUNNEL=ec2-12-345-678-90.us-west-1.compute.amazonaws.com
$ deisctl install platform && deisctl start platform
```
Deisctl will deploy Deis and make sure the services start properly.

## Configure Deis
Set the default domain used to anchor your applications:

Expand All @@ -137,6 +127,16 @@ If you want to allow `deis run` for one-off admin commands, you must provide an
$ deisctl config platform set sshPrivateKey=<path-to-private-key>
```

## Initialize the cluster
Once the cluster is up, get the hostname of any of the machines from EC2, set
DEISCTL_TUNNEL, and issue a `deisctl install`:
```console
$ ssh-add ~/.ssh/deis
$ export DEISCTL_TUNNEL=ec2-12-345-678-90.us-west-1.compute.amazonaws.com
$ deisctl install platform && deisctl start platform
```
Deisctl will deploy Deis and make sure the services start properly.

## Configure load balancer
The Deis provisioning scripts for EC2 automatically create an Elastic Load Balancer for your Deis
cluster. However, ELBs on EC2 have a default timeout of 60 seconds, which will disrupt a ``git push``
Expand Down
18 changes: 9 additions & 9 deletions contrib/gce/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,15 +305,7 @@ $ deisctl list
MACHINE IP METADATA
```

Now we can bootstrap the Deis containers:

```shell
deisctl install platform && deisctl start platform
```

This operation will take a while as all the Deis systemd units are loaded into the CoreOS cluster and the Docker images are pulled down. Grab some iced tea!

Once the command completes and `deisctl list` shows services as running, you can set the default domain used to anchor your applications:
Now set the default domain used to anchor your applications:

```console
$ deisctl config platform set domain=mycluster.local
Expand All @@ -327,6 +319,14 @@ If you want to allow `deis run` for one-off admin commands, you must provide an
$ deisctl config platform set sshPrivateKey=<path-to-private-key>
```

Now we can bootstrap the Deis containers:

```shell
deisctl install platform && deisctl start platform
```

This operation will take a while as all the Deis systemd units are loaded into the CoreOS cluster and the Docker images are pulled down. Grab some iced tea!

Register the admin user. The first user added to the system becomes the admin:

```console
Expand Down
26 changes: 13 additions & 13 deletions contrib/openstack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,19 +76,6 @@ By default, the Makefile will provision 1 router. You can override this by setti
$ export DEIS_NUM_ROUTERS=2
```

### Initialize the cluster
Once the cluster is up:
* **If required, allocate and associate floating IPs to any or all of your hosts**
* Get the IP address of any of the machines from Openstack
* set DEISCTL_TUNNEL and install the platform:

```console
$ export DEISCTL_TUNNEL=23.253.219.94
$ deisctl install platform && deisctl start platform
```

The installer will deploy Deis and make sure the services start properly.

## Configure Deis
Set the default domain used to anchor your applications:

Expand All @@ -104,6 +91,19 @@ If you want to allow `deis run` for one-off admin commands, you must provide an
$ deisctl config platform set sshPrivateKey=<path-to-private-key>
```

### Initialize the cluster
Once the cluster is up:
* **If required, allocate and associate floating IPs to any or all of your hosts**
* Get the IP address of any of the machines from Openstack
* set DEISCTL_TUNNEL and install the platform:

```console
$ export DEISCTL_TUNNEL=23.253.219.94
$ deisctl install platform && deisctl start platform
```

The installer will deploy Deis and make sure the services start properly.

### Use Deis!
After that, register with Deis!
```console
Expand Down
20 changes: 10 additions & 10 deletions contrib/rackspace/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,16 +54,6 @@ Usage: provision-rackspace-cluster.sh <key pair name> [flavor]
$ ./provision-rackspace-cluster.sh deis-key
```

### Initialize the cluster
Once the cluster is up, get the hostname of any of the machines from Rackspace, set
DEISCTL_TUNNEL and install the platform:
```console
$ export DEISCTL_TUNNEL=23.253.219.94
$ deisctl install platform && deisctl start platform
```

The installer will deploy Deis and make sure the services start properly.

## Configure Deis
Set the default domain used to anchor your applications:

Expand All @@ -79,6 +69,16 @@ If you want to allow `deis run` for one-off admin commands, you must provide an
$ deisctl config platform set sshPrivateKey=<path-to-private-key>
```

### Initialize the cluster
Once the cluster is up, get the hostname of any of the machines from Rackspace, set
DEISCTL_TUNNEL and install the platform:
```console
$ export DEISCTL_TUNNEL=23.253.219.94
$ deisctl install platform && deisctl start platform
```

The installer will deploy Deis and make sure the services start properly.

### Choose number of routers
By default, `deisctl` will provision 1 router. You can override this by scaling up:
```console
Expand Down

0 comments on commit 78518c0

Please sign in to comment.