Skip to content
This repository has been archived by the owner on Jan 28, 2022. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
sclevine committed Mar 17, 2017
1 parent 9cebb55 commit 8abfcb4
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 23 deletions.
24 changes: 2 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

```
NAME:
local - Build, download, and launch Cloud Foundry applications locally
local - Stage, launch, push, pull, and export CF apps -- in Docker
USAGE:
cf local stage <name> [(-b <URL>)] [-s <app> | -f <app>]
Expand Down Expand Up @@ -72,28 +72,8 @@ PUSH OPTIONS:
Default: false Output the CF Local version.
```

CF Local:
- Uses Docker to build and run Cloud Foundry apps locally.
- Supports downloading apps (droplets & settings) from a full CF installation.
- Supports mounting an empty (or non-existent) local directory to /home/vcap/app that recieves the staged app.
- Supports mounting a non-empty local directory to /home/vcap/app that replaces the staged app.

App settings (currently env vars and a start command) are downloaded to or manually specified in ./local.yml.
If no buildpack is specified during staging, the latest standard CF buildpacks are used to detect and compile your app.

NOTES:
- For safety reasons:
- Service forwarding tunnels are not active during staging
- Containers are never exported with remote service credentials
- Service details are never pulled from remote apps

TODO:
- `cf local push` - upload apps to a CF installation
- Improved support for connecting to local services via `VCAP_SERVICES`
- Improved support for connecting to CF services via `cf ssh` tunnel
- Memory quotas, disk quotas, and multiple app instances
- Support for running multiple apps in the same command
- Support for running apps in the background
- Support for specifying a custom rootfs
- Support for specifying a custom version of Diego
- `cf emulator` - run a full CF install in a docker container with the garden-docker backend pointed at the host
- Service credentials from remote apps are never stored in local.yml
2 changes: 1 addition & 1 deletion plugin/plugin.go
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ func (p *Plugin) GetMetadata() cfplugin.PluginMetadata {
},
Commands: []cfplugin.Command{{
Name: "local",
HelpText: "Build, download, and launch Cloud Foundry applications locally",
HelpText: "Stage, launch, push, pull, and export CF apps -- in Docker",
UsageDetails: cfplugin.Usage{Usage: usage},
}},
}
Expand Down

0 comments on commit 8abfcb4

Please sign in to comment.