Welcome to the Cloud Controller
- V3 API Docs
- V2 API Docs
- Continuous Integration Pipelines
- Notes on V3 Architecture
- capi-release - The bosh release used to deploy cloud controller
- cf-for-k8s - How Cloud Foundry (including Cloud Controller) is deployed against Kubernetes
- capi-k8s-release - The parts of cf-for-k8s that are specific to CF API (including Cloud Controller)
The Cloud Controller provides REST API endpoints to create and manage apps, services, user roles, and more!
The Cloud Controller supports Postgres and Mysql.
The Cloud Controller manages a blobstore for:
- Resource cache: During package upload resource matching, Cloud Controller will only upload files it doesn't already have in this cache.
When deployed via capi-release only:
- App packages: Unstaged files for an application
- Droplets: An executable containing an app and its runtime dependencies
- Buildpacks: Set of programs that transform packages into droplets
- Buildpack cache: Cached dependencies and build artifacts to speed up future staging
- Alibaba Cloud (Experimental)
- Local (NFS)
TLDR: Always run
bundle exec rake before committing
To maintain a consistent and effective approach to testing, please refer to the spec README and keep it up to date, documenting the purpose of the various types of tests.
rspec will randomly pick between postgres and mysql.
If postgres is not running on your OSX machine, you can start up a server by doing the following:
brew services start postgresql createuser -s postgres DB=postgres rake db:create
It will try to connect to those databases with the following connection string:
To specify a custom username, password, host, or port for either database type, you can override the default
connection string prefix (the part before the
cc_test database name) by setting the
POSTGRES_CONNECTION_PREFIX variables. Alternatively, to override the full connection string, including
the database name, you can set the
DB_CONNECTION_STRING environment variable. This will restrict you to only
running tests in serial, however.
For example, to run unit tests in parallel with a custom mysql username and password, you could execute:
MYSQL_CONNECTION_PREFIX=mysql2://custom_user:custom_password@localhost:3306 bundle exec rake
The following are examples of completely fully overriding the database connection string:
DB_CONNECTION_STRING="postgres://postgres@localhost:5432/cc_test" DB=postgres rake spec:serial DB_CONNECTION_STRING="mysql2://root:password@localhost:3306/cc_test" DB=mysql rake spec:serial
If you are running the integration specs (which are included in the full rake),
and you are specifying
DB_CONNECTION_STRING, you will also
need to have a second test database with
_integration_cc as the name suffix.
For example, if you are using:
You will also need a database called:
will create the above database when the
DB environment variable is set to postgres or mysql.
You should run this before running rake in order to ensure that the
cc_test database exists.
Running tests on a single file
The development team typically will run the specs to a single file as (e.g.)
bundle exec rspec spec/controllers/runtime/users_controller_spec.rb
Running all the unit tests
bundle exec rake spec
Note that this will run all tests in parallel by default. If you are setting a custom
you will need to run the tests in serial instead:
bundle exec rake spec:serial
To be able to run the unit tests in parallel and still use custom connection strings, use the
POSTGRES_CONNECTION_PREFIX environment variables described above.
Running static analysis
bundle exec rubocop
Running both unit tests and rubocop
bundle exec rake will run the unit tests first, and then
rubocop if they pass. To run
rubocop first, run:
RUBOCOP_FIRST=1 bundle exec rake
Cloud Controller uses Steno to manage its logs. Each log entry includes a "source" field to designate which module in the code the entry originates from. Some of the possible sources are 'cc.app', 'cc.app_stager', and 'cc.healthmanager.client'.
Here are some use cases for the different log levels:
error- the CC received a malformed HTTP request, or a request for a non-existent droplet
warn- the CC failed to delete a droplet, CC received a request with an invalid auth token
info- CC received a token from UAA, CC received a NATS request
debug2- CC created a service, updated a service
debug- CC syncs resource pool, CC uploaded a file
The Cloud Controller uses a YAML configuration file. For an example, see