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
33 changes: 26 additions & 7 deletions content/community.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,52 @@
# Community

BOSH is part of the open-source community, so you can easily find us in a few places...
BOSH is part of the open-source community, so you can easily find us in a few
places...


## Slack

The [Cloud Foundry Slack](https://cloudfoundry.slack.com) is a great place to ask questions or discuss issues - especially if you are still trying to figure out what might actually be wrong. Contributors, operators, and developers of BOSH are typically hanging out in the [`#bosh`](https://cloudfoundry.slack.com/messages/C02HPPYQ2/) channel and happy to help answer questions.

!!! info "Slack Invitation"
Slack requires members to be invited, so please [request an invite](https://slack.cloudfoundry.org/) from our bot first if you are new to the community.
Slack requires members to be invited, so please [request an
invite](https://slack.cloudfoundry.org/) from our bot first if you are
new to the community.


## GitHub

BOSH is open source, so you can find most of the code in either the [`cloudfoundry`](https://github.com/cloudfoundry) or [`cloudfoundry-incubator`](https://github.com/cloudfoundry-incubator) GitHub organizations. If you are looking for a repository to start with, [`cloudfoundry/bosh`](https://github.com/cloudfoundry/bosh) is a great place to start.
BOSH is open source, so you can find most of the code in the
[`cloudfoundry`](https://github.com/cloudfoundry) GitHub organizations. If you
are looking for a repository to start with,
[`cloudfoundry/bosh`](https://github.com/cloudfoundry/bosh) is a great place
to start.

Since BOSH is a larger project, there are quite a few repositories for the various components. If you are not sure which repository is best to discuss an issue or make a change, please feel free to ask! [Slack](#slack) usually works best for that, but you can also just [create an issue](https://github.com/cloudfoundry/bosh/issues/new) if that's easier.
Since BOSH is a larger project, there are quite a few repositories for the
various components. If you are not sure which repository is best to discuss an
issue or make a change, please feel free to ask! [Slack](#slack) usually works
best for that, but you can also just [create an
issue](https://github.com/cloudfoundry/bosh/issues/new) if that's easier.


## Roadmap

We use [Pivotal Tracker](https://www.pivotaltracker.com/) for keeping track of what we're working on and prioritizing tasks. We have several projects, but our main project is [CF BOSH](https://www.pivotaltracker.com/n/projects/956238). For an aggregated view of all our projects, check out [bosh-stories](https://github.com/cloudfoundry/bosh-stories) to see a quick summary of our recent and upcoming work.
We use [GitHub
Projects](https://github.com/orgs/cloudfoundry/projects?query=is%3Aopen) for
keeping track of what we're working on and prioritizing tasks.


## Mailing List

If you prefer mailing lists, you can find us through the [`cf-bosh` mailing list](https://lists.cloudfoundry.org/g/cf-bosh). Although it is quieter than [Slack](#slack), the community is usually able to help answer questions raised on the list. We also occasionally use this for announcements or product discussion.
If you prefer mailing lists, you can find us through the [`cf-bosh` mailing
list](https://lists.cloudfoundry.org/g/cf-bosh). Although it is quieter than
[Slack](#slack), the community is usually able to help answer questions raised
on the list. We also occasionally use this for announcements or product
discussion.


## Additional Resources

* [Ultimate Guide to BOSH](https://ultimateguidetobosh.com/) - a great resource for learning more about BOSH concepts
* [Ultimate Guide to
BOSH](https://web.archive.org/web/20260214185516/https://ultimateguidetobosh.com/) -
a great resource for learning more about BOSH concepts
15 changes: 10 additions & 5 deletions content/create-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -675,7 +675,6 @@ Example `private.yml`:

```yaml
---
blobstore_secret: 'does-not-matter'
blobstore:
local:
blobstore_path: /tmp/ardo-blobs
Expand All @@ -684,10 +683,16 @@ blobstore:
If you have a `private.yml` file:

* **Required**: Include the `blobstore_path` in the `private.yml` file.
* **Optional**: Include the `blobstore_path` in the `final.yml` file. Doing so allows you to `gitignore` the `private.yml` file but still allow the release to be downloaded and used on other systems.

!!! note
The `blobstore_secret` is required for the `local` type blobstore. This is true even though the `blobstore_secret` line is deprecated and its content does not matter. There is never a `blobstore_secret` line for blobstores of types other than `local`.
* **Optional**: Include the `blobstore_path` in the `final.yml` file. Doing so
allows you to `gitignore` the `private.yml` file but still allow the release
to be downloaded and used on other systems.

!!! warning "Managing split-configuration between `private.yml` and `final.yml`"
In CLI v2, the value of `/blobstore/<provider>/` in `private.yml` [is
shallow-merged with, and takes precedence over,](https://github.com/cloudfoundry/bosh-cli/blob/27b76482223696f45c8269d233a3cdd42cdb77a3/releasedir/fs_config.go#L114-L120) the value of `/blobstore/options/`
in `final.yml`. The CLI does not distinguish which file a blobstore
option should be placed in. Hence, it is possible to create and publish a
valid `final.yml` with secrets.
Comment thread
achrinza marked this conversation as resolved.

### Inform BOSH where blobs are {: #inform }

Expand Down
7 changes: 5 additions & 2 deletions content/package-vendoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,11 @@ Packages may also include `bosh/runtime.env` for loading specific functionality

When to use this approach:

- package is readily available from `bosh-packages` Github organization
- package is an internal implementation detail of your release that cannot or should not be swappable by an operator
- package is [readily
available](https://github.com/orgs/cloudfoundry/repositories?q=in%3Aname+bosh-package-)
from the `cloudfoundry` Github organization.
- package is an internal implementation detail of your release that cannot or
should not be swappable by an operator

When to be cautious with this approach:

Expand Down
41 changes: 12 additions & 29 deletions content/release-blobstore.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
!!! note
Examples require CLI v2.
This describes configuring a blobstore for publishing BOSH Releases with
**BOSH CLI v2+**, which is separate from [configuring the blobstore of a
BOSH Director](director-configure-blobstore).

A release blobstore contains [release blob](release-blobs.md) and created final releases.

Expand All @@ -8,8 +10,15 @@ Access to release blobstore is configured via two files:
- `config/final.yml` (checked into Git repository): contains blobstore location
- `config/private.yml` (is NOT checked into Git repository): contains blobstore credentials

CLI supports three different blobstore providers: `s3`, `gcs`, `azure-storage`
and `local`.
CLI supports three different blobstore providers: `s3`, `gcs`, and `local`.

!!! warning "Managing split-configuration between `private.yml` and `final.yml`"
In CLI v2, the value of `/blobstore/<provider>/` in `private.yml` [is
shallow-merged with, and takes precedence over,](https://github.com/cloudfoundry/bosh-cli/blob/27b76482223696f45c8269d233a3cdd42cdb77a3/releasedir/fs_config.go#L114-L120) the value of `/blobstore/options/`
in `final.yml`. The CLI does not distinguish which file a blobstore
option should be placed in. Hence, it is possible to create and publish a
valid `final.yml` with secrets.
Comment thread
achrinza marked this conversation as resolved.


## S3 Configuration {: #s3-config }

Expand Down Expand Up @@ -81,32 +90,6 @@ blobstore:

Nothing in `config/private.yml`.

---

## Azure Storage Account Configuration {: #azure-storage-config }

Azure Storage Account is supported from bosh version `278.0.0`.

**config/final.yml**

```yaml
---
blobstore:
provider: azure-storage
options:
container_name: <container_name>
account_name: <account_name>
```

**config/private.yml**

```yaml
---
blobstore:
options:
account_key: <account_key>
```

---
## Release Compression Configuration {: #no-compression }

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ pages:
- Builtin DAV Server: director-configure-blobstore.md
- Amazon S3: director-configure-blobstore.md
- Google Cloud Storage: director-configure-blobstore.md
- Azure Storage Account: director-configure-blobstore.md
- Managing Releases: managing-releases.md
- Managing Stemcells: managing-stemcells.md
- Auto-healing Capabilities: resurrector.md
Expand Down