From 8abfcb4ef329e804bd341fd5eef9c83a7b5a0fce Mon Sep 17 00:00:00 2001 From: Stephen Levine Date: Fri, 17 Mar 2017 01:32:21 -0400 Subject: [PATCH] Update README --- README.md | 24 ++---------------------- plugin/plugin.go | 2 +- 2 files changed, 3 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index f506d07..e4419a8 100644 --- a/README.md +++ b/README.md @@ -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 [(-b )] [-s | -f ] @@ -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 \ No newline at end of file diff --git a/plugin/plugin.go b/plugin/plugin.go index 402a64e..0b82961 100644 --- a/plugin/plugin.go +++ b/plugin/plugin.go @@ -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}, }}, }