Skip to content

Commit ff3e029

Browse files
committed
docs(*): add bare-metal guide
Adds some light documentation around bare metal provisioning. closes #730
1 parent 1737835 commit ff3e029

2 files changed

Lines changed: 12 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ on DigitalOcean, you should use the
2020

2121
# Deploying Deis
2222

23-
Deis is a set of Docker containers that can be deployed anywhere including public cloud, private cloud, bare metal or your workstation. Decide where you'd like to deploy Deis, then follow the deployment-specific documentation for [Rackspace](contrib/rackspace/README.md) or [EC2](contrib/ec2/README.md). Documentation for OpenStack and bare-metal provisioning are forthcoming.
23+
Deis is a set of Docker containers that can be deployed anywhere including public cloud, private cloud, bare metal or your workstation. Decide where you'd like to deploy Deis, then follow the deployment-specific documentation for [Rackspace](contrib/rackspace/README.md), [EC2](contrib/ec2/README.md), or [bare-metal](contrib/bare-metal/README.md) provisioning. Documentation for other platforms is forthcoming. Want to see a particular platform supported? Open an [issue](https://github.com/deis/deis/issues/new) and we'll investigate.
2424

2525
Trying out Deis? Continue following these instructions for a local cluster setup. This is also a great Deis testing/development environment.
2626

contrib/bare-metal/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Provision a Deis Cluster on bare-metal hardware
2+
3+
Deis clusters can be provisioned anywhere [CoreOS](https://coreos.com/) can, including on your own hardware. To get CoreOS running on raw hardware, you can boot with [PXE](https://coreos.com/docs/running-coreos/bare-metal/booting-with-pxe/) or [iPXE](https://coreos.com/docs/running-coreos/bare-metal/booting-with-ipxe/) - this will boot a CoreOS machine running entirely from RAM. Then, you can [install CoreOS to disk](https://coreos.com/docs/running-coreos/bare-metal/installing-to-disk/).
4+
5+
Considerations when deploying Deis:
6+
* Use machines with ample disk space and RAM (we use [large instances](https://aws.amazon.com/ec2/instance-types/) on EC2, for comparison)
7+
* Choose an appropriate [cluster size](https://github.com/coreos/etcd/blob/master/Documentation/optimal-cluster-size.md)
8+
* Supply our [cloud config file](../coreos/user-data), making sure to use a [new discovery URL](https://discovery.etcd.io/new)
9+
* Use the `alpha` channel of CoreOS
10+
11+
We hope to improve our documentation around bare metal provisioning. If you're deployed Deis on bare metal and think you can help improve this documentation, please submit a pull request. Thanks!

0 commit comments

Comments
 (0)