Skip to content

Commit 0941f6e

Browse files
committed
[RFC] Cloud Controller Blobstore Type: storage-cli
1 parent 93eae5d commit 0941f6e

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Meta
2+
[meta]: #meta
3+
- Name: Cloud Controller Blobstore Type: storage-cli
4+
- Start Date: 2025-07-18
5+
- Author(s): @johha, @stephanme
6+
- Status: Draft <!-- Acceptable values: Draft, Approved, On Hold, Superseded -->
7+
- RFC Pull Request: [community #1253](https://github.com/cloudfoundry/community/pull/1253)
8+
9+
10+
## Summary
11+
12+
Add a blobstore type `storage-cli` to the Cloud controller that is based on the Bosh storage CLIs. Long-term, the `storage-cli` blobstore type shall replace the blobstore type `fog`.
13+
14+
## Problem
15+
16+
Cloud Controller uses the fog gem family to interface with the blobstores of different IaaS providers like Azure, AWS, GCP, and Alibaba Cloud.
17+
These Ruby gems are largely unmaintained, introducing risks such as:
18+
* Dependency on deprecated SDKs (e.g. Azure SDK for Ruby has reached EOL)
19+
* Blocking Ruby version upgrades
20+
* Potential for unpatched CVEs
21+
22+
## Proposal
23+
24+
Bosh faced similar issues, as it is also written in Ruby and interacts with blobstores. To address this, Bosh introduced standalone CLI tools which shell out from Ruby to handle all blobstore operations:
25+
- https://github.com/cloudfoundry/bosh-azure-storage-cli
26+
- https://github.com/cloudfoundry/bosh-s3cli
27+
- https://github.com/cloudfoundry/bosh-gcscli
28+
- https://github.com/cloudfoundry/bosh-ali-storage-cli
29+
30+
These storage CLIs are implemented in Go and use the respective provider golang SDKs that are well supported for the foreseeable future.
31+
32+
Cloud Controller shall implement a new blobstore type `storage-cli` that uses the mentioned storage CLIs for blobstore operations. Missing functionality needed by the Cloud Controller shall be added to the storage CLIs in a compatible way:
33+
- missing commands such as `copy`, `list`, `properties`, `ensure-bucket-exists`
34+
- missing configuration parameters such as GCP Uniform Bucket Access and timeout parameters
35+
36+
It shall be possible to switch from blobstore type `fog` to type `storage-cli` in a productive Cloud Foundry installation. Once blobstore type `storage-cli` supports all four mentioned IaaS providers, the blobstore type `fog` can be removed from Cloud Controller.
37+
38+
### Storage CLI
39+
40+
A new area "Storage CLI" shall be added to the Foundational Infrastructure WG in order to allow cooperation of Bosh and CAPI teams:
41+
42+
- create a new "Storage CLI" area
43+
- add existing approvers of areas "VM deployment lifecycle (BOSH)" (FI) and "CAPI" (ARI) as initial approvers to this new area
44+
- create a new repository `storage-cli` in this area with the goal to consolidate all existing bosh storage CLIs here
45+
- copy one existing bosh storage cli into this new repository as starting point (most likely [bosh-azure-storage-cli](https://github.com/cloudfoundry/bosh-azure-storage-cli))
46+
- setup CI, implement missing commands and configuration parameters
47+
- continue with the remaining bosh storage CLIs
48+
49+
### Bosh
50+
51+
- switch from bosh storage cli to new `storage-cli`
52+
- eventually archive the old bosh storage CLI repos
53+
54+
### Cloud Controller
55+
56+
- add a new blobstore type `storage-cli` that shells out to `storage-cli` for blobstore operations
57+
- validate functionality with CATS
58+
- benchmark blobstore operation performance and compare with blobstore type `fog`, enhance performance tests where necessary
59+
- eventually deprecate and remove the blobstore type `fog` once all IaaS providers are covered
60+
61+
### cf-deployment
62+
63+
- add experimental ops files per IaaS provider for using the `storage-cli` blobstore type
64+
- eventually promote those ops files and replace the existing fog-based blobstore ops files
65+
66+
## Additional Information
67+
68+
- [cloud_controller_ng #4443](https://github.com/cloudfoundry/cloud_controller_ng/pull/4443) - ADR: Use Bosh Storage CLIs for Blobstore Operations

0 commit comments

Comments
 (0)