-
Notifications
You must be signed in to change notification settings - Fork 265
/
mkdocs.yml
357 lines (347 loc) · 13 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
site_name: Cloud Foundry BOSH
site_url: "https://bosh.io/docs/"
repo_name: 'cloudfoundry/docs-bosh'
repo_url: 'https://github.com/cloudfoundry/docs-bosh'
edit_uri: edit/master/content/
# non-default since our repo itself is called "docs"
docs_dir: content
pages:
- About:
- Welcome: index.md
- Project Goals: problems.md
- Community: community.md
- Installation:
- Installing the CLI: cli-v2-install.md
- Quick Start: quick-start.md
- Alibaba Cloud: init-alicloud.md
- Amazon Web Services: init-aws.md
- Google Cloud Platform: init-google.md
- Microsoft Azure: init-azure.md
- OpenStack: init-openstack.md
- VirtualBox: bosh-lite.md
- VMware vSphere: init-vsphere.md
- Guides:
- Deploying Software:
- Core Concepts:
- Updating Cloud Config: update-cloud-config.md
- Building a Manifest: deployment-basics.md
- Uploading Stemcells: uploading-stemcells.md
- Uploading Releases: uploading-releases.md
- Deploying: deploying.md
- Using Persistent Disks:
- Persistent Disks: persistent-disks.md
- Taking Snapshots: snapshots.md
- Using XFS: persistent-disk-fs.md
- Using Links:
- Links: links.md
- Manually Configuring Links: links-manual.md
- Running Errands: errands.md
- VM Update Strategy: changing-deployment-vm-strategy.md
- VM Anti-Affinity: vm-anti-affinity.md
- Credentials on tmpfs: creds-tmpfs.md
- Locking compiled releases: locking-compiled-releases.md
- Troubleshooting:
- Failing VMs: troubleshooting.md
- Monitoring: monitoring.md
- Process Monitoring with Monit: vm-monit.md
- IaaS Reconciliation: cck.md
- Deployment Recovery: recover.md
- Migrating:
- To Availability Zones: migrated-from.md
- From the Ruby CLI: cli-v2-diff.md
- Migrating to Noble Numbat: noble-migration.md
- Packaging Software:
- Core Concepts:
- Creating a Release: create-release.md
- Using Links:
- Sharing Properties: links-properties.md
- Configuring the Blobstore:
- Release Blobstore: release-blobstore.md
- Using S3 & IAM Policies: s3-release-blobstore.md
- Working with Blobs: release-blobs.md
- Testing:
- Unit Testing Job Templates: job-templates.md
- Migrating Packages to Jammy Jellyfish: jammy-migration.md
- Scheduled Processes: scheduled-procs.md
- Creating Compiled Releases: compiled-releases.md
- Using Errands: errands.md
- Configuring Processes:
- Recommended Property Types: props-common.md
- Packaging and Compiling:
- Creating Packages: packages.md
- Reusing Packages: package-vendoring.md
- Windows Compatibility:
- Overview: windows.md
- Creating a Windows Stemcell for vSphere: windows-stemcell-create.md
- Sample Release: windows-sample-release.md
- Using BPM:
- Overview: bpm/bpm.md
- Configuration: bpm/config.md
- Runtime: bpm/runtime.md
- Migrating to BPM: bpm/transitioning.md
- Undefined Behaviors: bpm/undefined.md
- Operating Director:
- Monitoring:
- Prometheus Metrics: director-metrics.md
- Auditing Events: events.md
- Reviewing Tasks: director-tasks.md
- Logging API Access: director-access-events.md
- Securing:
- Using Basic Users: director-users.md
- Integrating with UAA:
- Configuring Director: director-users-uaa.md
- Managing Permissions with UAA Scopes: director-users-uaa-scopes.md
- Using BOSH Teams: director-bosh-teams.md
- Configuring SSL Certificates: director-certs.md
- Director SSL Certificate Configuration with OpenSSL: director-certs-openssl.md
- Rotating Credentials:
- Credentials: credential-rotation.md
- NATS:
- CA Rotation: nats-ca-rotation.md
- Blobstore:
- CA Rotation: blobstore-ca-rotation.md
- Agent Password Rotation: blobstore-agent-password-rotation.md
- Bootstrap mbus:
- SSL Rotation: mbus-ssl-rotation.md
- CredHub:
- Encryption Password Rotation: credhub-encryption-password-rotation.md
- Signed URLs: director-blobstore-signed-urls.md
- Configuring the Database:
- Builtin PostgreSQL: director-configure-db.md
- External MySQL: director-configure-db.md
- Configuring the Blobstore:
- Builtin DAV Server: director-configure-blobstore.md
- Amazon S3: director-configure-blobstore.md
- Google Cloud Storage: director-configure-blobstore.md
- Managing Releases: managing-releases.md
- Managing Stemcells: managing-stemcells.md
- Auto-healing Capabilities: resurrector.md
- Using Health Monitor: hm-config.md
- Using Runtime Config:
- Overview: runtime-config.md
- Common Addons: addons-common.md
- Using Deploy Config: deploy-config.md
- Integrating with CredHub:
- Variable Types: variable-types.md
- Tasks Cleanup: scheduled-task-cleanup.md
- Optional Features:
- Explicit ARP Flushing: flush-arp.md
- Removing Dev Tools from VMs: remove-dev-tools.md
- Installing Certificates on VMs: trusted-certs.md
- Troubleshooting: tips.md
- Using the CLI: &clireference
- Commands: cli-v2.md
- Global Flags: cli-global-flags.md
- Environments: cli-envs.md
- Tunneling: cli-tunnel.md
- Composing YAML:
- Interpolating Variables: cli-int.md
- Creating Ops Files: cli-ops-files.md
- Advanced Networking:
- Multi-Cloud Support:
- Using CPI Config: cpi-config.md
- Using AWS: guide-multi-cpi-aws.md
- Using IPv6 on vSphere: guide-ipv6-on-vsphere.md
- Advanced Bootstrapping:
- Using a Public IP: init-external-ip.md
- Enabling SSH Access: jumpbox.md
- In-depth Topics:
- Native DNS Support: dns.md
- Components of BOSH: bosh-components.md
- Deploying Step by Step: deploying-step-by-step.md
- Agent Interactions: agent-cpi-interactions.md
- Configuring NTP: ntp-config.md
- Disaster Recovery in Case of AZ Outage: disaster-recovery.md
- Virtual Machines:
- Structure of a VM: vm-struct.md
- Filesystem Locations: vm-config.md
- Using Logs: job-logs.md
- Instance Metadata: instance-metadata.md
- Development:
- Building a CPI: build-cpi.md
- Building a Stemcell: build-stemcell.md
- Repacking Stemcells: repack-stemcell.md
- Target Personas: personas.md
- Reference:
- Terminology: terminology.md
- Deployment Config: manifest-v2.md
- Cpi Config: cpi-config.md
- Director Cloud Config:
- Usage: cloud-config.md
- Availability Zones: azs.md
- Networks: networks.md
- Managed Networks: managed-networks.md
- Director APIs:
- Director HTTP API: director-api-v1.md
- Links API: links-api.md
- Director Runtime Config: runtime-config.md
- Generic Configs: configs.md
- Cloud Provider Interface:
- Version 2:
- Overview: cpi-api-v2.md
- Methods:
- attach_disk: cpi-api-v2-method/attach-disk.md
- calculate_vm_cloud_properties: cpi-api-v2-method/calculate-vm-cloud-properties.md
- create_disk: cpi-api-v2-method/create-disk.md
- create_stemcell: cpi-api-v2-method/create-stemcell.md
- create_network: cpi-api-v2-method/create-network.md
- create_vm: cpi-api-v2-method/create-vm.md
- delete_disk: cpi-api-v2-method/delete-disk.md
- delete_snapshot: cpi-api-v2-method/delete-snapshot.md
- delete_stemcell: cpi-api-v2-method/delete-stemcell.md
- delete_network: cpi-api-v2-method/delete-network.md
- delete_vm: cpi-api-v2-method/delete-vm.md
- detach_disk: cpi-api-v2-method/detach-disk.md
- get_disks: cpi-api-v2-method/get-disks.md
- has_disk: cpi-api-v2-method/has-disk.md
- has_vm: cpi-api-v2-method/has-vm.md
- info: cpi-api-v2-method/info.md
- reboot_vm: cpi-api-v2-method/reboot-vm.md
- resize_disk: cpi-api-v2-method/resize-disk.md
- update_disk: cpi-api-v2-method/update-disk.md
- set_disk_metadata: cpi-api-v2-method/set-disk-metadata.md
- set_vm_metadata: cpi-api-v2-method/set-vm-metadata.md
- snapshot_disk: cpi-api-v2-method/snapshot-disk.md
- Version 1:
- Overview: cpi-api-v1.md
- Migrating to version 2: cpi-api-v2-migration-guide.md
- Methods:
- attach_disk: cpi-api-v1-method/attach-disk.md
- configure_networks: cpi-api-v1-method/configure-networks.md
- create_vm: cpi-api-v1-method/create-vm.md
- current_vm_id: cpi-api-v1-method/current-vm-id.md
- delete_vm: cpi-api-v1-method/delete-vm.md
- detach_disk: cpi-api-v1-method/detach-disk.md
- info: cpi-api-v1-method/info.md
- RPC Interface: cpi-api-rpc.md
- Release Management:
- Overview: release.md
- Release URLs: release-urls.md
- Jobs:
- Usage: jobs.md
- Update Lifecycle: job-lifecycle.md
- Lifecycle Hooks:
- Drain: drain.md
- Pre-start: pre-start.md
- Post-start: post-start.md
- Post-deploy: post-deploy.md
- Pre-stop: pre-stop.md
- Post-stop: post-stop.md
- Links:
- Common Types: links-common-types.md
- Deployment Convergence: deployment-convergence.md
- Operating Systems:
- Ubuntu: ubuntu-os.md
- Windows Server: windows-os.md
- CentOS: centos-os.md
- CLI reference: *clireference
- Legacy Documentation:
# docs we should keep linkable
- Basic Workflow: basic-workflow.md
- Deployment Manifest v1: deployment-manifest.md
- Sample Manifest: sample-manifest.md
- CLI v1 Installation: bosh-cli.md
- CLI v1 Commands: sysadmin-commands.md
- CLI v1 Backup / Restore: director-backup.md
# docs which will be quickly migrated
- What is a Deployment?: deployment.md
- What is a Stemcell?: stemcell.md
- Recent Changes: recent.md
- Deploying BOSH with create-env: init.md
- "--- Cloud Providers": divider.md
- Alibaba Cloud:
- Usage: alicloud-cpi.md
- Common Errors: alicloud-cpi-errors.md
- Amazon Web Services:
- Overview: aws.md
- Usage: aws-cpi.md
- Common Errors: aws-cpi-errors.md
- IAM Users: aws-iam-users.md
- IAM Profiles: aws-iam-instance-profiles.md
- Using Instance Storage: aws-instance-storage.md
- Google Cloud Platform:
- Overview: google.md
- Usage: google-cpi.md
- Required Permissions: google-required-permissions.md
- Microsoft Azure:
- Overview: azure.md
- Usage: azure-cpi.md
- Common Errors: azure-cpi-errors.md
- Creating Resources: azure-resources.md
- Managed Identity: azure-managed-identity.md
- OpenStack:
- Overview: openstack.md
- Usage: openstack-cpi.md
- Common Errors: openstack-cpi-errors.md
- Using VRRP: openstack-vrrp.md
- Using Human-readable VM names: openstack-human-readable-vm-names.md
- Using Keystone API v2: openstack-keystonev2.md
- Using Light Stemcells: openstack-light-stemcells.md
- Multi-homed VMs: openstack-multiple-networks.md
- Extended Registry configuration: openstack-registry.md
- Self-signed Endpoints: openstack-self-signed-endpoints.md
- RackHD:
- Usage: rackhd-cpi.md
- VirtualBox:
- Usage: virtualbox-cpi.md
- VMware vSphere:
- Overview: vsphere.md
- Usage: vsphere-cpi.md
- Common Errors: vsphere-cpi-errors.md
- Recovery from an ESXi Host Failure: vsphere-esxi-host-failure.md
- vSphere High Availability: vsphere-ha.md
- Migrating Datastores: vsphere-migrate-datastores.md
- Recovery from a vSphere Network Partitioning Fault: vsphere-network-partition.md
- Storage DRS and vMotion Support: vsphere-vmotion-support.md
- Bootstrapping with Resource Pools: init-vsphere-rp.md
- Using Human-readable VM names: vsphere-human-readable-names.md
- Warden:
- Usage: warden-cpi.md
# this hack avoids divider.md showing up in navigation and site search
- "--- ": divider.md
theme:
name: material
custom_dir: theme
favicon: assets/images/favicon.2776d0bae488.png
feature:
tabs: true
palette:
primary: blue
accent: indigo
logo: assets/images/logo.d93e7da69dbf.png
extra_css:
- 'assets/stylesheets/extra.61026d2ee9f4.css'
markdown_extensions:
- markdown.extensions.admonition
- markdown.extensions.codehilite
- markdown.extensions.def_list
- markdown.extensions.attr_list
- markdown.extensions.footnotes
- markdown.extensions.meta
- markdown.extensions.toc(permalink=true)
- pymdownx.arithmatex
- pymdownx.betterem(smart_enable=all)
- pymdownx.caret
- pymdownx.critic
- pymdownx.emoji:
emoji_generator: !!python/name:pymdownx.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tasklist(custom_checkbox=true)
- pymdownx.tilde
extra:
social:
- type: 'github'
link: 'https://github.com/cloudfoundry/bosh'
- type: 'slack'
link: 'https://cloudfoundry.slack.com/messages/C02HPPYQ2/'
google_analytics:
# avoid forks accidentally using us
- !!python/object/apply:os.getenv ["GOOGLE_ANALYTICS_KEY"]
- auto
# since we publish via bosh.io, avoid unintentionally using gh-pages
remote_branch: docroot