Skip to content

Commit 3e99cc6

Browse files
committed
Merge pull request #34 from krancour/remove-do-and-bare-metal-refs
doc(install/contrib): Remove DO and bare metal instructions
2 parents c02359b + 0d94ded commit 3e99cc6

6 files changed

Lines changed: 4 additions & 40 deletions

File tree

mkdocs.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ pages:
1212
- Installing Deis:
1313
- Quick Start: installing-deis/quickstart.md
1414
- System Requirements: installing-deis/system-requirements.md
15-
- Bare Metal: installing-deis/bare-metal.md
16-
- DigitalOcean: installing-deis/digitalocean.md
1715
- Installing the Deis Platform: installing-deis/installing-the-deis-platform.md
1816
- Using Deis:
1917
- Installing the Client: using-deis/installing-the-client.md

src/contributing/development-environment.md

Lines changed: 2 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -135,32 +135,7 @@ Although writing and executing tests are critical to ensuring code quality, most
135135

136136
### Running a Kubernetes Cluster for Development
137137

138-
Before proceding further, it is imperative to understand that all Deis components, including the Deis PaaS ([deis/workflow][workflow]) run atop the [Kubernetes][k8s] container orchestration system. Whether for production or development and testing, a healthy Kubernetes cluster (version 1.1 or greater) is the required starting point.
139-
140-
All Deis components treat Kubernetes as the lowest common denominator and Deis components make no assumptions about:
141-
142-
* Your hosts' underlying operating system(s).
143-
* The underlying physical or virtual infrastructure. It makes no difference whether your hosts:
144-
* Are physical machines (i.e. bare metal).
145-
* Are virtual machines provisioned through a cloud provider.
146-
* Are virtual machines running locally on your laptop.
147-
148-
With Kubernetes used as a uniform interface between Deis components and the infrastructure below, it is also (largely) unimportant to Deis components _how_ your Kubernetes cluster was provisioned. As such, the Deis team is also not strongly opinionated (at this time) about how best to provision a Kubernetes cluster.
149-
150-
Any official options listed on Kubernetes own [Getting Started][k8s-getting-started] page should be sufficient.
151-
152-
#### DigitalOcean
153-
154-
In many cases, testing your changes to Deis components is accomplished most easily and economically on just a few Vagrant VMs - sometimes just one. However, at times, if one wishes to conserve local resources, test changes at scale, or demonstrate changes to others, it is advisable to move these activities into a cloud environment.
155-
156-
[DigitalOcean][] is Deis' officially recommended provider for contributors wishing to extend their development and testing into the cloud. See [Provision a new DO cluster](../installing-deis/digitalocean.md) for further details and then continue to follow the instructions below.
157-
158-
!!! important
159-
Are you a new contributor to Deis? Your first [Pull Request][pr] could earn you credit at [DigitalOcean][]! Submit your changes and then email <deis@engineyard.com>. When your PR is merged, the maintainer team will send you a DigitalOcean credit based on the value of your contribution.
160-
161-
### Installing Deis Components
162-
163-
With a functioning Kubernetes cluster, proceed with Deis installation using [these instructions](../installing-deis/digitalocean.md) and then continue to follow the instructions below.
138+
To run a Kubernetes cluster locally or elsewhere to support your development activities, refer to Deis installation instructions [here](../installing-deis/quickstart.md).
164139

165140
### Using a Development Registry
166141

@@ -186,7 +161,7 @@ In non-Linux environments:
186161
export DEIS_REGISTRY=<IP of the docker-deis Docker Machine VM>:5000/
187162
```
188163

189-
If your development cluster runs on a cloud provider such as DigitalOcean, a local registry such as the one above will not be accessible to your Kubernetes nodes. In such cases, a public registry such as [DockerHub][dh] or [quay.io][quay] will suffice.
164+
If your development cluster runs on a cloud provider such as Google Container Engine, a local registry such as the one above will not be accessible to your Kubernetes nodes. In such cases, a public registry such as [DockerHub][dh] or [quay.io][quay] will suffice.
190165

191166
To use DockerHub for this purpose, for instance:
192167

@@ -275,7 +250,6 @@ things you should do when proposing a change to any Deis component.
275250
[testing]: testing.md
276251
[k8s]: http://kubernetes.io/
277252
[k8s-getting-started]: http://kubernetes.io/gettingstarted/
278-
[digitalocean]: https://www.digitalocean.com/
279253
[pr]: submitting-a-pull-request.md
280254
[dh]: https://hub.docker.com/
281255
[quay]: https://quay.io/

src/contributing/overview.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ We are always looking for help improving the core platform, other workloads, too
1616

1717
When you're ready to begin writing code, review [Design Documents][dd] and get your [Development Environment][dev-environment] set up.
1818

19-
!!! important
20-
If you're a new contributor to Deis, your Pull Request could earn you [credit at DigitalOcean][do-credit]!
21-
2219
## Triage Issues
2320

2421
If you don't have time to code, consider helping with triage. The community will thank you for saving them time by spending some of yours. See [Triaging Issues](triaging-issues.md) for more info.
@@ -30,6 +27,5 @@ Interact with the community on our user mailing list or live in our IRC channel,
3027
[workflow]: https://github.com/deis/workflow
3128
[dd]: design-documents.md
3229
[dev-environment]: development-environment.md
33-
[do-credit]: development-environment.md#digitalocean-credit
3430
[docs]: https://github.com/deis/workflow/tree/master/docs
3531
[easy-fix]: https://github.com/deis/workflow/labels/easy-fix

src/installing-deis/bare-metal.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

src/installing-deis/digitalocean.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

src/installing-deis/quickstart.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Choose one of the following providers and deploy a new kubernetes cluster:
1414
- [Google Container Engine](https://cloud.google.com/container-engine/docs/before-you-begin)
1515
- [Vagrant](http://kubernetes.io/v1.1/docs/getting-started-guides/vagrant.html)
1616

17+
Reference [this table](http://kubernetes.io/v1.1/docs/getting-started-guides/#table-of-solutions) in the official Kubernetes documentation for a more extensive (but still non-exhaustive) list of Kubernetes provisioning options supported by the project or the community.
18+
1719
## Prerequisites
1820
Please make sure you enable the Daemon Sets api if you are installing a pre-1.2 version of kubernetes. As it is not turned on by default. You can learn more about how to do that [here](http://kubernetes.io/v1.1/docs/api.html#enabling-resources-in-the-extensions-group).
1921

0 commit comments

Comments
 (0)