Cloud Foundry Cloud Controller
Ruby Other
Latest commit 93b25a9 Feb 15, 2017 @jberkhahn jberkhahn committed with aashah Organization entitlement returns correct relationship response
[#139315021]

Signed-off-by: Tim Hausler <thausler@pivotal.io>
Permalink
Failed to load latest commit information.
app Organization entitlement returns correct relationship response Feb 17, 2017
bin allow console to properly load Nov 12, 2015
bosh Add `temporary_local_sync` flag to toggle ruby sync Feb 15, 2017
config Add GET /v3/spaces/:guid/relationships/isolation_segment Feb 16, 2017
db/migrations Add username from UAA token to all events Feb 2, 2017
docs Organization entitlement returns correct relationship response Feb 17, 2017
lib Merge pull request #764 from cfibmers/vcap_app_host Feb 16, 2017
middleware Add and allow global_auditor scope to have read permissions in v2 Jan 31, 2017
scripts Update run local cc scripts to know where traffic controller is Jan 24, 2017
spec Organization entitlement returns correct relationship response Feb 17, 2017
vendor/errors Update error message when staging hits memory quota Jan 9, 2017
.gemnasium.yml Add gemnasium file. Sep 22, 2014
.gitignore move v3 docs into v3 subfolder Jun 8, 2016
.rspec Make rspec backtraces smaller Apr 20, 2016
.rspec_parallel Revert "Revert "Use parallel_tests to run tests in parallel"" Oct 7, 2016
.rubocop.yml Bump rubocop to 0.41 Dec 17, 2016
.ruby-version Bump ruby version to 2.3.3 Dec 7, 2016
.travis.yml Add code climate token to travis config Feb 10, 2017
CONTRIBUTING.md changing capi-release from master to develop Dec 16, 2016
Gemfile limit supported fog storage providers Jan 20, 2017
Gemfile.lock limit supported fog storage providers Jan 20, 2017
Guardfile merge cc/ccdb with ccng/ccdb_ng Jun 6, 2014
ISSUE_TEMPLATE.md fix typo Jul 27, 2016
LICENSE Revert "Update License and Notice for project" May 23, 2016
NOTICE Streamline multi-copyright notice Feb 3, 2017
PULL_REQUEST_TEMPLATE.md Update PULL_REQUEST_TEMPLATE.md Jan 6, 2017
README.md Update README.md Feb 10, 2017
Rakefile appease rubocop Oct 8, 2016

README.md

Build Status Code Climate Test Coverage slack.cloudfoundry.org

Welcome to the Cloud Controller

Helpful Resources

Components

Cloud Controller

The Cloud Controller provides REST API endpoints to create and manage apps, services, user roles, and more!

Database

The Cloud Controller supports Postgres and Mysql.

Blobstore

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.
  • 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

Cloud Controller currently supports webdav and the following fog connectors:

  • Azure
  • Openstack
  • Local (NFS)
  • Google
  • AWS

Runtime

The Cloud Controller uses Diego to stage and run apps and tasks.

See Diego Design Notes for more details.

Contributing

Please read the contributors' guide

Testing

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.

By default rspec will randomly pick between postgres and mysql.

It will try to connect to those databases with the following connection string: postgres: postgres://postgres@localhost:5432/cc_test mysql: mysql2://root:password@localhost:3306/cc_test

rake db:create 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.

You can specify the full connection string via the DB_CONNECTION_STRING environment variable. Examples:

DB_CONNECTION_STRING="postgres://postgres@localhost:5432/cc_test" rake
DB_CONNECTION_STRING="mysql2://root:password@localhost:3306/cc_test" rake

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:

DB_CONNECTION_STRING="postgres://postgres@localhost:5432/cc_test"

You will also need a database called:

`cc_test_integration_cc`

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 tests

bundle exec rake spec

Running static analysis

bundle exec rubocop

Logs

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', 'cc.dea.client' 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

Configuration

The Cloud Controller uses a YAML configuration file. For an example, see config/cloud_controller.yml.