Skip to content

s3 custom blobstore ops #1251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Conversation

kinjelom
Copy link
Contributor

@kinjelom kinjelom commented Jul 2, 2025

WHAT is this change about?

Implement a new ops-file, operations/use-s3-custom-blobstore.yml, which adds an ops stanza that lets operators select and configure any S3-compatible blobstore (per the Fog S3 “other” settings in Cloud Foundry docs).

What customer problem is being addressed? Use customer persona to define the problem e.g. Alana is unable to...

Alana wants to deploy CF on an environment with the private S3 compatible Blobstore (e.g. MinIO), but she needs to configure: endpoint, aws_signature_version and path_style

Please provide any contextual information.

  • Adds operations/use-s3-custom-blobstore.yml
  • References official S3-other configuration docs: fog-s3-other
  • No existing PRs depend on this; it’s purely additive.

Has a cf-deployment including this change passed cf-acceptance-tests?

  • YES
  • NO

Does this PR introduce a breaking change? Please take a moment to read through the examples before answering the question.

  • YES
  • NO

How should this change be described in cf-deployment release notes?

We can now use operations/use-s3-custom-blobstore.yml to point any S3-compatible blobstore.

Does this PR introduce a new BOSH release into the base cf-deployment.yml manifest or any ops-files?

  • YES
  • NO

Does this PR make a change to an experimental or GA'd feature/component?

  • experimental feature/component
  • GA'd feature/component

Please provide Acceptance Criteria for this change?

bosh interpolate cf-deployment.yml \
-o operations/use-external-blobstore.yml \
-o operations/use-s3-custom-blobstore.yml \
-v blobstore_access_key_id="my-access-key-id" \
-v blobstore_secret_access_key="my-access-key" \
-v aws_region="default" \
-v blobstore_signature_version="2" \
-v blobstore_endpoint="https://my-blobstore" \
-v blobstore_path_style=true

Verify settings in the rendered manifest (bosh interpolate) match the provided values.

What is the level of urgency for publishing this change?

  • Urgent - unblocks current or future work
  • Slightly Less than Urgent

@jochenehret jochenehret requested review from a team July 2, 2025 11:47
Copy link
Contributor

@jochenehret jochenehret left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ops file works. But please add it to the list in ./operations/README.md.


- type: replace
path: /instance_groups/name=api/jobs/name=cloud_controller_ng/properties/cc/buildpacks/fog_connection
error: "Please apply 'use-external-blobstore.yml' before applying 'use-s3-blobstore.yml'."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn't produce this error message. If I interpolate just this ops file with cf-deployment.yml, I get:

$ bosh interpolate -o ./operations/use-s3-custom-blobstore.yml cf-deployment.yml
Error 'operation [0] in ./operations/use-s3-custom-blobstore.yml failed': Expected to find a map key 'fog_connection' for path '/instance_groups/name=api/jobs/name=cloud_controller_ng/properties/cc/buildpacks/fog_connection' (found map keys: 'blobstore_type', 'webdav_config')

Exit code 1

Should we leave out this error message?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants