Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 2.5 KB

README.md

File metadata and controls

79 lines (55 loc) · 2.5 KB
Raw

Service Instance Logging CLI Plugin

This repository provides a Cloud Foundry CLI plugin for accessing the logs of service instances created by Spring Cloud Dataflow or, in the future, Spring Cloud Services.

For information on plugin development, see Developing a plugin.

Building

To build the plugin, run:

$ rm $GOPATH/bin/service-instance-logs-cli-plugin
$ cd service-instance-logs-cli-plugin
$ go install -ldflags="-X main.pluginVersion=$(cat version)"

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/service-instance-logs-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

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

$ cf install-plugin -f $GOPATH/bin/service-instance-logs-cli-plugin

You can also install the plugin from the Cloud Foundry cf-cli plugins repository:

$ cf install-plugin -r CF-Community "Service Instance Logging"

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 service-instance-logging

Command docs

With the plugin installed in the cf CLI, the Service Instance Logs CLI plugin command docs can be generated by running the following commands:

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

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.

Testing

First install Ginkgo.

Run the tests as follows:

$ cd spring-cloud-services-cli-plugin
$ ginkgo -r

License

The Service Instance Logs CLI plugin is Open Source software released under the Apache 2.0 license.

Contributing

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