Skip to content

Commit

Permalink
Updates some of the docs around configure-bosh
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Moran committed Dec 21, 2016
1 parent 7f5fe62 commit 8f475d2
Show file tree
Hide file tree
Showing 5 changed files with 195 additions and 22 deletions.
8 changes: 6 additions & 2 deletions docs/configure-bosh/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
← [back to Commands](../README.md)

# `om configure-bosh`

The `configure-bosh` command will allow you to setup your BOSH tile on the OpsManager.
The command currently supports [AWS](aws.md) and [GCP](gcp.md).

## Supported Infrastructures
* [AWS](aws.md)
* [GCP](gcp.md)
* [Azure](azure.md)
* [vSphere](vsphere.md)

## Command Usage
```
Expand Down
24 changes: 20 additions & 4 deletions docs/configure-bosh/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,17 @@ This can be done with the simple `bash` chainsaw `cat key.pem | awk '{print $1 "
}
```

#### --security-configuration
No additional security configuration is strictly required.

##### Minimal example
```json
{
"trusted_certificates": "some-trusted-certificates",
"vm_password_type": "generate"
}
```

#### --az-configuration

##### Minimal example
Expand All @@ -40,13 +51,18 @@ This can be done with the simple `bash` chainsaw `cat key.pem | awk '{print $1 "
}
```

#### --security-configuration
No additional security configuration is strictly required.
#### --networks-configuration

##### Minimal example
```json
{
}
```

#### --network-assignment

##### Minimal example
```json
{
"trusted_certificates": "some-trusted-certificates",
"vm_password_type": "generate"
}
```
54 changes: 54 additions & 0 deletions docs/configure-bosh/azure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
← [back to `configure-bosh`](README.md)

# Azure-specific inputs for the `configure-bosh` command

#### --iaas-configuration

##### Minimal example
```json
{
}
```

#### --director-configuration

##### Minimal example
```json
{
}
```

#### --security-configuration
No additional security configuration is strictly required.

##### Minimal example
```json
{
"trusted_certificates": "some-trusted-certificates",
"vm_password_type": "generate"
}
```

#### --az-configuration

##### Minimal example
```json
{
}
```

#### --networks-configuration

##### Minimal example
```json
{
}
```

#### --network-assignment

##### Minimal example
```json
{
}
```
90 changes: 84 additions & 6 deletions docs/configure-bosh/gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To easily format this JSON for use as a string here, use `cat service_account_ke
```

#### --director-configuration
**Note regarding `ntp_servers_string`**: We recommend using this NTP server to all PCF users on GCP.
**Note regarding `ntp_servers_string`**: We recommend using the metadata server (169.254.169.254) as the NTP server to all PCF users on GCP.

##### Minimal example
```json
Expand All @@ -26,23 +26,101 @@ To easily format this JSON for use as a string here, use `cat service_account_ke
}
```

#### --security-configuration
No additional security configuration is strictly required.

##### Minimal example
```json
{
"trusted_certificates": "some-trusted-certificates",
"vm_password_type": "generate"
}
```

#### --az-configuration
We tend to use the "us-central1" region because it has 3 zones to balance across for high-availability deployments.

##### Minimal example
```json
{
"availability_zones": ["us-central1-a","us-central1-b","us-central1-c"]
"availability_zones": [
"us-central1-a",
"us-central1-b",
"us-central1-c"
]
}
```

#### --security-configuration
No additional security configuration is strictly required.
#### --networks-configuration
In the example configuration below, we have taken a single GCP network and described it as 3 Ops Manager networks along subnet boundaries.

##### Minimal example
```json
{
"trusted_certificates": "some-trusted-certificates",
"vm_password_type": "generate"
"icmp_checks_enabled": false,
"networks": [
{
"name": "opsman-network",
"iaas_identifier": "some-network/opsman-subnet/us-central1",
"subnets": [
{
"cidr": "10.0.0.0/24",
"reserved_ip_ranges": "10.0.0.0-10.0.0.4",
"dns": "8.8.8.8",
"gateway": "10.0.0.1",
"availability_zones": [
"us-central1-a",
"us-central1-b",
"us-central1-c"
]
}
]
},
{
"name": "ert-network",
"iaas_identifier": "some-network/ert-subnet/us-central1",
"subnets": [
{
"cidr": "10.0.4.0/22",
"reserved_ip_ranges": "10.0.4.0-10.0.4.4",
"dns": "8.8.8.8",
"gateway": "10.0.4.1",
"availability_zones": [
"us-central1-a",
"us-central1-b",
"us-central1-c"
]
}
]
},
{
"name": "services-network",
"iaas_identifier": "some-network/services-subnet/us-central1",
"subnets": [
{
"cidr": "10.0.8.0/22",
"reserved_ip_ranges": "10.0.8.0-10.0.8.4",
"dns": "8.8.8.8",
"gateway": "10.0.8.1",
"availability_zones": [
"us-central1-a",
"us-central1-b",
"us-central1-c"
]
}
]
}
]
}
```

#### --network-assignment
This flag will set the network assignment for the BOSH Director tile itself.

##### Minimal example
```json
{
"singleton_availability_zone": "us-central1-a",
"network": "opsman-network"
}
```
41 changes: 31 additions & 10 deletions docs/configure-bosh/vsphere.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# vSphere configure-bosh
← [back to `configure-bosh`](README.md)

#### --iaas-configuration
Note for `disk_type`, the only valid options are 'thick' or 'thin'.
# vSphere-specific inputs for the `configure-bosh` command

Minimal example:
#### --iaas-configuration
**Note for `disk_type`**: the only valid options are 'thick' or 'thin'.

##### Minimal example
```json
{
"vcenter_host": "some-vcenter-host",
Expand All @@ -18,29 +19,49 @@ Minimal example:
"bosh_template_folder": "some-template-folder",
"bosh_disk_path": "some-disk-path"
}

```

#### --director-configuration
Change this to a valid internal NTP server address for your organization

Minimal example:
##### Minimal example
```json
{
"ntp_servers_string": "10.0.0.1"
}
```

#### --az-configuration
Not currently available, work in progress

#### --security-configuration
No additional security configuration is strictly required.

Minimal example:
##### Minimal example
```json
{
"trusted_certificates": "some-trusted-certificates",
"vm_password_type": "generate"
}
```

#### --az-configuration

##### Minimal example
```json
{
}
```

#### --networks-configuration

##### Minimal example
```json
{
}
```

#### --network-assignment

##### Minimal example
```json
{
}
```

0 comments on commit 8f475d2

Please sign in to comment.