Skip to content
This repository was archived by the owner on Jun 2, 2021. It is now read-only.

Commit ac648d8

Browse files
authored
Merge pull request cloudfoundry#1932 from cloudfoundry/matt-royal-readme-update
Update README.md to reflect VM/k8s deployments
2 parents ebab0e7 + beadfd8 commit ac648d8

File tree

1 file changed

+14
-31
lines changed

1 file changed

+14
-31
lines changed

README.md

Lines changed: 14 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@
1010
* [V3 API Docs](http://v3-apidocs.cloudfoundry.org)
1111
* [V2 API Docs](http://apidocs.cloudfoundry.org)
1212
* [Continuous Integration Pipelines](https://capi.ci.cf-app.com)
13+
* [Notes on V3 Architecture](https://github.com/cloudfoundry/cloud_controller_ng/wiki/Notes-on-V3-Architecture)
14+
* [capi-release](https://github.com/cloudfoundry/capi-release) - The bosh release used to deploy cloud controller
15+
* [cf-for-k8s](https://github.com/cloudfoundry/cf-for-k8s) - How Cloud Foundry (including Cloud Controller) is deployed against Kubernetes
16+
* [capi-k8s-release](https://github.com/cloudfoundry/capi-k8s-release) - The parts of cf-for-k8s that are specific to CF API (including Cloud Controller)
1317

1418
## Components
1519

@@ -25,7 +29,10 @@ The Cloud Controller supports Postgres and Mysql.
2529

2630
The Cloud Controller manages a blobstore for:
2731

32+
All Platforms:
2833
* Resource cache: During package upload resource matching, Cloud Controller will only upload files it doesn't already have in this cache.
34+
35+
When deployed via capi-release only:
2936
* App packages: Unstaged files for an application
3037
* Droplets: An executable containing an app and its runtime dependencies
3138
* Buildpacks: Set of programs that transform packages into droplets
@@ -42,10 +49,15 @@ Cloud Controller currently supports [webdav](http://www.webdav.org/) and the fol
4249

4350
### Runtime
4451

45-
The Cloud Controller uses [Diego](https://github.com/cloudfoundry/diego-release) to stage and run apps and tasks.
46-
52+
The Cloud Controller on VMs uses [Diego](https://github.com/cloudfoundry/diego-release) to stage and run apps and tasks.
4753
See [Diego Design Notes](https://github.com/cloudfoundry/diego-design-notes) for more details.
4854

55+
When deployed on Kubernetes, Cloud Controller uses
56+
[kpack](https://github.com/pivotal/kpack) to build images from source with
57+
[Cloud Native Buildpacks](https://buildpacks.io) and
58+
[Eirini](https://github.com/cloudfoundry-incubator/eirini) to run apps directly on the Kubernetes cluster.
59+
60+
4961
## Contributing
5062

5163
Please read the [contributors' guide](https://github.com/cloudfoundry/cloud_controller_ng/blob/master/CONTRIBUTING.md) and the [Cloud Foundry Code of Conduct](https://cloudfoundry.org/code-of-conduct/)
@@ -133,35 +145,6 @@ By default, `bundle exec rake` will run the unit tests first, and then `rubocop`
133145

134146
RUBOCOP_FIRST=1 bundle exec rake
135147

136-
### CF Acceptance Tests (CATs)
137-
138-
To ensure our changes to the Cloud Controller correctly integrate with the rest of the Cloud Foundry components like Diego,
139-
we run the [CF Acceptance Tests (CATs)](https://github.com/cloudfoundry/cf-acceptance-tests) against a running CF deployment.
140-
This test suite uses the CF CLI to ensure end-user actions like `cf push` function end-to-end.
141-
142-
For more substantial code changes and PRs, please deploy your changes and ensure that at least the core CATs suite passes.
143-
Follow the instructions [here](https://github.com/cloudfoundry/cf-acceptance-tests#test-setup) for setting up the CATs suite.
144-
The following will run the core test suites against a local bosh-lite:
145-
146-
```bash
147-
cd ~/go/src/github.com/cloudfoundry/cf-acceptance-tests
148-
cat > integration_config.json <<EOF
149-
{
150-
"api": "api.bosh-lite.com",
151-
"apps_domain": "bosh-lite.com",
152-
"admin_user": "admin",
153-
"admin_password": "admin",
154-
"skip_ssl_validation": true
155-
}
156-
EOF
157-
export CONFIG=$PWD/integration_config.json
158-
./bin/test -nodes=3
159-
```
160-
161-
If your change touches a more specialized part of the code such as Isolation Segments or Tasks,
162-
please opt into the corresponding test suites.
163-
The full list of optional test suites can be found [here](https://github.com/cloudfoundry/cf-acceptance-tests#test-configuration).
164-
165148
## Logs
166149

167150
Cloud Controller uses [Steno](http://github.com/cloudfoundry/steno) to manage its logs.

0 commit comments

Comments
 (0)