A Cloud Foundry CLI plugin for Spring Cloud Dataflow for PCF
Branch: master
Clone or download
git
Latest commit 54dbbd6 Dec 18, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cfutil Shuffle code into better structure Nov 3, 2017
cli Add test suite file to cli package Nov 7, 2017
dataflow [#152549054] Added to Data Flow shell command. Jan 27, 2018
docs
download Adjust tests for linux Jan 22, 2018
format Initial commit Nov 1, 2017
httpclient Obtain dataflow server URL from the dataflow broker Nov 15, 2017
java
pluginutil Initial commit Nov 1, 2017
serviceutil Support skipper-shell command Jan 12, 2018
skipper Support skipper-shell command Jan 12, 2018
vendor Vendor dependencies using govendor Nov 10, 2017
.gitignore git ignore shell log Nov 3, 2017
CONTRIBUTING.md Initial commit Nov 1, 2017
LICENSE
NOTICE Initial commit Nov 1, 2017
README.md Added install from CF Community Apr 5, 2018
plugin.go
version bump to 1.0.1 Dec 17, 2018

README.md

Spring Cloud Dataflow for PCF CLI Plugin

This repository provides a Cloud Foundry CLI plugin for Spring Cloud Dataflow for PCF.

For information on plugin development, see Developing a plugin.

Building

To build the plugin, install go and govendor (see the Go Development guide for instructions) and issue:

$ rm $GOPATH/bin/spring-cloud-dataflow-for-pcf-cli-plugin
$ cd $GOPATH/src/github.com/pivotal-cf/spring-cloud-dataflow-for-pcf-cli-plugin
$ govendor install -ldflags="-X main.pluginVersion=$(cat version)" +local

This builds the plugin with the current version number in the version file.

Note: if an invalid version number is provided, the build will succeed, but the plugin will fail to install (with exit status code 64).

To print the version number of the built plugin, run it as a stand-alone executable, for example:

$ $GOPATH/bin/spring-cloud-dataflow-for-pcf-cli-plugin
This program is a plugin which expects to be installed into the cf CLI. It is not intended to be run stand-alone.
Plugin version: 0.0.8

Installing

From CF Community

To install the plugin from the Cloud Foundry Community Plugins, run the following command:

cf install-plugin -r CF-Community "spring-cloud-dataflow-for-pcf"

From Manual Build

To install the plugin in the cf CLI, first build it and then issue:

$ cf install-plugin -f $GOPATH/bin/spring-cloud-dataflow-for-pcf-cli-plugin

The plugin's commands may then be listed by issuing cf help.

To update the plugin, uninstall it as follows and then re-install the plugin as above:

$ cf uninstall-plugin spring-cloud-dataflow-for-pcf-cli-plugin

Command docs

The Spring Cloud Dataflow for PCF CLI plugin command docs can be generated by running the following commands:

$ cd docs
$ ./generate-cli-docs-from-help.bash

This needs to be done whenever commands are added, modified, or deleted. Note that the script contains a list of commands which needs to be kept in step with the available commands.

The generated docs may be viewed here.

Go Development

See the Go Development guide. (If you just want to build and install the plugin, simply install go and govendor.)

Testing

Run the tests as follows:

$ cd $GOPATH/src/github.com/pivotal-cf/spring-cloud-dataflow-for-cli-plugin
$ govendor test +local

License

The Spring Cloud Dataflow for PCF CLI plugin is Open Source software released under the Apache 2.0 license.

Contributing

Contributions are welcomed. Please refer to the Contributor's Guide.