Skip to content

Commit

Permalink
clean up dev docs
Browse files Browse the repository at this point in the history
Signed-off-by: Marco Voelz <[email protected]>
  • Loading branch information
cppforlife authored and voelzmo committed Oct 13, 2015
1 parent 9b1840f commit ba36085
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 347 deletions.
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,7 @@ Relevant documentation pages from bosh.io:

## Developer Notes

See the [CLI workflow](docs/cli_workflow.md) for more information on creating a manifest.

To build bosh-init see our [workstation setup docs](https://github.com/cloudfoundry/bosh-init/blob/master/docs/build.md).

To run bosh-init tests see our [test docs](https://github.com/cloudfoundry/bosh-init/blob/master/docs/test.md).

To deploy BOSH with UAA using bosh-init see our [UAA docs](https://github.com/cloudfoundry/bosh-init/blob/master/docs/uaa.md).

To learn more about the bosh-init design see our [architecture docs](https://github.com/cloudfoundry/bosh-init/blob/master/docs/architecture.md).
- [Workstation setup docs](docs/build.md)
- [Test docs](docs/test.md)
- [CLI workflow](docs/cli_workflow.md)
- [Architecture docs](docs/architecture.md)
155 changes: 0 additions & 155 deletions docs/cli_workflow.md
Original file line number Diff line number Diff line change
@@ -1,158 +1,3 @@
# Create deployment manifest

This file will be used by bosh-init to deploy BOSH on a single VM to AWS. See [the documentation on bosh.io](http://bosh.io/docs/init.html) for additional examples for other infrastructures.

### Example deployment manifest

```yaml
---
name: bosh

releases:
- name: bosh
url: https://bosh.io/d/github.com/cloudfoundry/bosh?v=206
sha1: 04649aa32f910f8ff11cc25a38e563d4d1beb6db
- name: bosh-aws-cpi
url: https://bosh.io/d/github.com/cloudfoundry-incubator/bosh-aws-cpi-release?v=30
sha1: 627f7ab28ca6cc945750eab75cd4eb7e3e335895

resource_pools:
- name: vms
network: private
stemcell:
url: https://bosh.io/d/stemcells/bosh-aws-xen-hvm-ubuntu-trusty-go_agent?v=3012
sha1: 3380b55948abe4c437dee97f67d2d8df4eec3fc1
cloud_properties:
instance_type: m3.xlarge
ephemeral_disk: {size: 25_000, type: gp2}
availability_zone: AVAILABILITY-ZONE # <--- Replace with Availability Zone

disk_pools:
- name: disks
disk_size: 20_000
cloud_properties: {type: gp2}

networks:
- name: private
type: manual
subnets:
- range: 10.0.0.0/24
gateway: 10.0.0.1
dns: [10.0.0.2]
cloud_properties: {subnet: SUBNET-ID} # <--- Replace with Subnet ID
- name: public
type: vip

jobs:
- name: bosh
instances: 1

templates:
- {name: nats, release: bosh}
- {name: redis, release: bosh}
- {name: postgres, release: bosh}
- {name: blobstore, release: bosh}
- {name: director, release: bosh}
- {name: health_monitor, release: bosh}
- {name: registry, release: bosh}
- {name: cpi, release: bosh-aws-cpi}

resource_pool: vms
persistent_disk_pool: disks

networks:
- name: private
static_ips: [10.0.0.6]
default: [dns, gateway]
- name: public
static_ips: [ELASTIC-IP] # <--- Replace with Elastic IP

properties:
nats:
address: 127.0.0.1
user: nats
password: nats-password

redis:
listen_addresss: 127.0.0.1
address: 127.0.0.1
password: redis-password

postgres: &db
host: 127.0.0.1
user: postgres
password: postgres-password
database: bosh
adapter: postgres

registry:
address: 10.0.0.6
host: 10.0.0.6
db: *db
http: {user: admin, password: admin, port: 25777}
username: admin
password: admin
port: 25777

blobstore:
address: 10.0.0.6
port: 25250
provider: dav
director: {user: director, password: director-password}
agent: {user: agent, password: agent-password}

director:
address: 127.0.0.1
name: my-bosh
db: *db
cpi_job: cpi
max_threads: 10

hm:
director_account: {user: admin, password: admin}
resurrector_enabled: true

aws: &aws
access_key_id: ACCESS-KEY-ID # <--- Replace with AWS Access Key ID
secret_access_key: SECRET-ACCESS-KEY # <--- Replace with AWS Secret Key
default_key_name: bosh
default_security_groups: [bosh]
region: us-east-1

agent: {mbus: "nats://nats:[email protected]:4222"}

ntp: &ntp [0.pool.ntp.org, 1.pool.ntp.org]

cloud_provider:
template: {name: cpi, release: bosh-aws-cpi}

ssh_tunnel:
host: ELASTIC-IP # <--- Replace with your Elastic IP address
port: 22
user: vcap
private_key: ./bosh.pem # Path relative to this manifest file

mbus: "https://mbus:mbus-password@ELASTIC-IP:6868" # <--- Replace with Elastic IP

properties:
aws: *aws
agent: {mbus: "https://mbus:[email protected]:6868"}
blobstore: {provider: local, path: /var/vcap/micro_bosh/data/cache}
ntp: *ntp
```
See [https://github.com/cloudfoundry/bosh/tree/master/release/jobs](https://github.com/cloudfoundry/bosh/tree/master/release/jobs) for defaults
# Deploy VM
The command below deploys a VM with given releases using CPI release and stemcell.
```
bosh-init deploy bosh.yml
```

---

# Deployment Flow

This section describes how the CLI works. These steps are performed by the CLI.
Expand Down
56 changes: 0 additions & 56 deletions docs/migrating_from_godeps.md

This file was deleted.

127 changes: 0 additions & 127 deletions docs/uaa.md

This file was deleted.

0 comments on commit ba36085

Please sign in to comment.