Skip to content

Commit dc25468

Browse files
committed
update readme to point to docs
1 parent 8b7a73d commit dc25468

File tree

2 files changed

+11
-74
lines changed

2 files changed

+11
-74
lines changed

README.md

+10-61
Original file line numberDiff line numberDiff line change
@@ -30,67 +30,16 @@ See [test.sh](test.sh) for example usage of different ops files.
3030

3131
## Sample installation instructions
3232

33-
* [BOSH Lite on VirtualBox](docs/bosh-lite-on-vbox.md)
34-
* AWS (below)
35-
36-
```
37-
$ git clone https://github.com/cloudfoundry/bosh-deployment ~/workspace/bosh-deployment
38-
39-
# Create a directory to keep Director deployment
40-
$ mkdir -p ~/deployments/bosh-1
41-
42-
$ cd ~/deployments/bosh-1
43-
44-
# Deploy a Director -- ./creds.yml is generated automatically
45-
$ bosh create-env ~/workspace/bosh-deployment/bosh.yml \
46-
--state ./state.json \
47-
-o ~/workspace/bosh-deployment/aws/cpi.yml \
48-
--vars-store ./creds.yml \
49-
-v access_key_id=... \
50-
-v secret_access_key=... \
51-
-v region=us-east-1 \
52-
-v az=us-east-1b \
53-
-v default_key_name=bosh \
54-
-v default_security_groups=[bosh] \
55-
-v subnet_id=subnet-... \
56-
-v director_name=bosh-1 \
57-
-v internal_cidr=10.0.0.0/24 \
58-
-v internal_gw=10.0.0.1 \
59-
-v internal_ip=10.0.0.6 \
60-
--var-file private_key=~/Downloads/bosh.pem
61-
62-
# Alias deployed Director
63-
$ bosh -e 10.0.0.6 --ca-cert <(bosh int ./creds.yml --path /director_ssl/ca) alias-env bosh-1
64-
65-
# Log in to the Director
66-
$ export BOSH_CLIENT=admin
67-
$ export BOSH_CLIENT_SECRET=`bosh int ./creds.yml --path /admin_password`
68-
69-
# Update cloud config -- single az
70-
$ bosh -e bosh-1 update-cloud-config ~/workspace/bosh-deployment/aws/cloud-config.yml \
71-
-v az=us-east-1b \
72-
-v subnet_id=subnet-... \
73-
-v internal_cidr=10.0.0.0/24 \
74-
-v internal_gw=10.0.0.1
75-
76-
# Upload specific stemcell
77-
$ bosh -e bosh-1 upload-stemcell https://...
78-
79-
# Get a deployment running
80-
$ git clone https://github.com/cppforlife/zookeeper-release ~/workspace/zookeeper-release
81-
$ bosh -e bosh-1 -d zookeeper deploy ~/workspace/zookeeper-release/manifests/zookeeper.yml
82-
```
83-
84-
To generate creds (without deploying anything) or just to check if your manifest builds:
85-
86-
```
87-
$ bosh int ~/workspace/bosh-deployment/bosh.yml \
88-
--var-errs \
89-
-o ~/workspace/bosh-deployment/aws/cpi.yml \
90-
--vars-store ./creds.yml \
91-
-v access_key_id=... \
92-
-v secret_access_key=...
93-
```
33+
* [Create an environment](https://bosh.io/docs/init.html)
34+
* [On Local machine (BOSH Lite)](https://bosh.io/docs/bosh-lite.html)
35+
* [On AWS](https://bosh.io/docs/init-aws.html)
36+
* [Expose Director on a Public IP](https://bosh.io/docs/init-external-ip.html)
37+
* [On Azure](https://bosh.io/docs/init-azure.html)
38+
* [On OpenStack](https://bosh.io/docs/init-openstack.html)
39+
* [On vSphere](https://bosh.io/docs/init-vsphere.html)
40+
* [On vCloud](https://bosh.io/docs/init-vcloud.html)
41+
* [On SoftLayer](https://bosh.io/docs/init-softlayer.html)
42+
* [On Google Compute Platform](https://bosh.io/docs/init-google.html)
9443

9544
Please ensure you have security groups setup correctly. i.e:
9645

docs/jumpbox-user.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,3 @@
11
## Jumpbox User
22

3-
It's recommended:
4-
5-
- to maintain a separate jumpbox VM for your environment
6-
- do not SSH to the Director
7-
- use `bosh ssh` to access VMs in your deployments and use jumpbox VM as your SSH gateway
8-
9-
To obtain SSH access specifically to the Director VM you can opt into `jumpbox-user.yml` ops file. It will add a `jumpbox` user to the VM (by using `user_add` job from cloudfoundry/os-conf-release).
10-
11-
```
12-
$ bosh int creds.yml --path /jumpbox_ssh/private_key > jumpbox.key
13-
$ chmod 600 jumpbox.key
14-
$ ssh jumpbox@<external-or-internal-ip> -i jumpbox.key
15-
```
3+
Instructions moved to <https://bosh.io/docs/jumpbox>.

0 commit comments

Comments
 (0)