Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
.idea/
/site

\#*
.#*
*~
*.swp
43 changes: 0 additions & 43 deletions content/cli-env-deps.md

This file was deleted.

8 changes: 7 additions & 1 deletion content/cloud-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,13 @@ The Director creates compilation VMs for release compilation. The Director will
- **az** [String, required]: Name of the AZ defined in AZs section to use for creating compilation VMs.
- **vm_type** [String, optional]: Name of the VM type defined in VM types section to use for creating compilation VMs. Alternatively, you can specify the `vm_resources`, or `cloud_properties` key.
- **orphan_workers** [Boolean, optional]: When enabled, BOSH will orphan compilation VMs after they finishing compiling packages for the VMs to be deleted asynchronously (instead of blocking the deployment). Default `false`. Available in bosh-release v267+.
- **vm_resources** [Hash, optional]: Specifies generic VM resources such as CPU, RAM and disk size that are automatically translated into correct VM cloud properties to determine VM size. VM size is determined on best effort basis as some IaaSes may not support exact size configuration. Currently some CPIs (Google and Azure) do not support this functionality. Available in bosh-release v264+.
- **vm_resources** [Hash, optional]: Specifies generic VM resources such as
CPU, RAM and disk size that are automatically translated into correct VM
cloud properties to determine VM size. VM size is determined on best effort
basis as some IaaSes may not support exact size configuration. Currently
some CPIs do not support this functionality (Check for "Generic VM Resource
Configuration" support in their "Overview" page). Available in bosh-release
v264+.
- **vm_extensions** [Array, optional]: Names of the VM extensions defined in the VM extensions section to use for creating compilation VMs.
- **cloud_properties** [Hash, optional]: Describes any IaaS-specific properties needed to create VMs. Most IaaSes require this. Examples: `instance_type`, `availability_zone`. Default is `{}` (empty Hash).
- **network** [String, required]: References a valid network name defined in the Networks block. BOSH assigns network properties to compilation VMs according to the type and properties of the specified network.
Expand Down
5 changes: 4 additions & 1 deletion content/configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ Additionally, in some cases it may be useful to split cloud config and/or other

In addition to the Director types an operator can set config of any other type using the [`update-config`](cli-v2.md#update-config) CLI command. The config file can be any file containing valid YAML. Root of the file must be a hash.

One of the use cases for providing such open ended functionality is to provide shared configuration API for supporting BOSH services instead of reimplementing something similar in each service. An upcoming example that will use this feature will be introduction of the `resurrection` config type that will allow operators to define custom resurrection rules, later read and interpreted by the Health Monitor.
One of the use cases for providing such open-ended functionality is to provide
shared configuration API for supporting BOSH services instead of
reimplementing something similar in each service. One example is the
[`resurrection` config type](resurrector.md#enable-with-resurrection-config).

---

Expand Down
4 changes: 2 additions & 2 deletions content/cpi-api-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ For an overview of the sequence of the CPI calls, please have a look at the foll

Examples of API request and response:

- [Building a CPI: RPC - Request](https://bosh.io/docs/build-cpi.html#request)
- [Building a CPI: RPC - Response](https://bosh.io/docs/build-cpi.html#response)
- [RPC Interface - Request](cpi-api-rpc.md#request)
- [RPC Interface - Response](cpi-api-rpc.md#response)

If you're looking to get started on building a CPI, this [short guide](build-cpi.md) may be helpful. To learn more about the technical implementation, continue reading or refer to the [RPC Interface](cpi-api-rpc.md) for more details.

Expand Down
2 changes: 1 addition & 1 deletion content/dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -798,7 +798,7 @@ bosh update-runtime-config bosh-deployment/runtime-configs/dns.yml --vars-store

Redeploy all VMs.

--
---

## Instance `records.json` Data

Expand Down
54 changes: 27 additions & 27 deletions content/git-lfs-release-blobstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,58 +108,58 @@ The `final_blobs/` directory should NOT be in `.gitignore` because Git LFS-track

1. Add the blob to your release:

```shell
bosh add-blob ~/Downloads/some-package-1.0.0.tar.gz some-package-1.0.0.tar.gz
```
```shell
bosh add-blob ~/Downloads/some-package-1.0.0.tar.gz some-package-1.0.0.tar.gz
```

The `bosh add-blob` command copies the file to `blobs/` and updates `config/blobs.yml`.
The `bosh add-blob` command copies the file to `blobs/` and updates `config/blobs.yml`.

2. Commit to Git:

```shell
git add config/blobs.yml
git commit -m "Add some-package 1.0.0 blob"
```
```shell
git add config/blobs.yml
git commit -m "Add some-package 1.0.0 blob"
```

Git LFS automatically tracks the blob file via `.gitattributes` patterns.
Git LFS automatically tracks the blob file via `.gitattributes` patterns.

### Creating a Final Release

1. Create the final release:

```shell
bosh create-release --final
```
```shell
bosh create-release --final
```

This generates the final release tarball and places it in the `final_blobs/` directory.
This generates the final release tarball and places it in the `final_blobs/` directory.

2. Commit to Git:

```shell
git add config/blobs.yml config/index.yml final_blobs/
git commit -m "Finalize release v1.0.0"
git tag v1.0.0
```
```shell
git add config/blobs.yml config/index.yml final_blobs/
git commit -m "Finalize release v1.0.0"
git tag v1.0.0
```

The `final_blobs/` directory contents are automatically tracked by Git LFS via `.gitattributes`.
The `final_blobs/` directory contents are automatically tracked by Git LFS via `.gitattributes`.

### For Contributors

External contributors follow the same workflow:

1. Clone the repository (Git LFS objects are downloaded automatically):

```shell
git clone https://github.com/your-org/my-release.git
```
```shell
git clone https://github.com/your-org/my-release.git
```

2. Add or update blobs:

```shell
bosh add-blob ~/Downloads/new-dependency-2.0.0.tar.gz new-dependency-2.0.0.tar.gz
git add config/blobs.yml
git commit -m "Bump new-dependency to 2.0.0"
```
```shell
bosh add-blob ~/Downloads/new-dependency-2.0.0.tar.gz new-dependency-2.0.0.tar.gz
git add config/blobs.yml
git commit -m "Bump new-dependency to 2.0.0"
```

3. Push the changes (including LFS objects):

Expand Down
4 changes: 2 additions & 2 deletions content/jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ of each job they'd like to add property validation to:
BOSH extends JSON Schema with a custom `certificate` type, which can be used
to validate for parseable PEM-encoded X.509 v3 certificates:

```json title="jobs/<job_name>/properties_schema.json"
```json title="jobs/&lt;job_name&gt;/properties_schema.json"
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
Expand All @@ -164,7 +164,7 @@ to validate for parseable PEM-encoded X.509 v3 certificates:
Zero-length strings are valid for the `certificate` type. To require at least
one parseable PEM certificate, use `minLength`:

```json title="jobs/<job_name>/properties_schema.json"
```json title="jobs/&lt;job_name&gt;/properties_schema.json"
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
Expand Down
3 changes: 3 additions & 0 deletions content/networks.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,10 @@ networks:
cloud_properties: {subnet: subnet-9be6c3f7}
```

### Multiple Subnets

Schema for dynamic network definition with multiple subnets (available in v241+):

- **name** [String, required]: Name used to reference this network configuration
- **type** [String, required]: Value should be `dynamic`
- **subnets** [Array, required]: Lists subnets in this network.
Expand Down
5 changes: 0 additions & 5 deletions content/rackhd-cpi.md

This file was deleted.

5 changes: 2 additions & 3 deletions content/stemcell.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ infrastructures without worrying about the differences between OS images.

The Cloud Foundry BOSH team is responsible for producing and maintaining an
official set of stemcells. See the [stemcells section of
bosh.io](https://bosh.io/stemcells) to see the infrastructures and operating
bosh.io](/stemcells/) to see the infrastructures and operating
systems that are currently supported.

Stemcells are distributed as tarballs.
Expand Down Expand Up @@ -88,6 +88,5 @@ stages defined here:

### Links

- [CI Source Repo](https://github.com/cloudfoundry/bosh-stemcells-ci)
- [Stemcell Builder](https://github.com/cloudfoundry/bosh-linux-stemcell-builder)
- [Stemcell Hardening](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/tanzu-operations-manager/3-0/tanzu-ops-manager/security-pcf-infrastructure-stemcell-index.html)
- [Stemcell Hardening](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/tanzu-operations-manager/3-3/tanzu-ops-manager/security-pcf-infrastructure-stemcell-index.html)
9 changes: 2 additions & 7 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ nav:
- Community: community.md
- Installation:
- Installing the CLI: cli-v2-install.md
- CLI env Dependencies: cli-env-deps.md
- Quick Start: quick-start.md
- Alibaba Cloud: init-alicloud.md
- Amazon Web Services: init-aws.md
Expand Down Expand Up @@ -116,9 +115,7 @@ nav:
- 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 Database: director-configure-db.md
- Configuring the Blobstore: director-configure-blobstore.md
- Managing Releases: managing-releases.md
- Managing Stemcells: managing-stemcells.md
Expand Down Expand Up @@ -294,8 +291,6 @@ nav:
- 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:
Expand Down Expand Up @@ -392,7 +387,7 @@ extra:
- icon: fontawesome/brands/github
link: 'https://github.com/cloudfoundry/bosh'
- icon: fontawesome/brands/slack
link: 'https://cloudfoundry.slack.com/messages/C02HPPYQ2/'
link: 'https://slack.cloudfoundry.org/'

generator: false

Expand Down