cloudfoundry/cf-drain-cli

Name: cf-drain-cli

Owner: Cloud Foundry

Description: null

Created: 2017-11-29 00:18:12.0

Updated: 2018-05-18 17:53:11.0

Pushed: 2018-05-19 02:09:05.0

Homepage: null

Size: 878

Language: Go

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

CF Drain CLI Plugin

The CF Drain CLI Plugin is a CF CLI plugin to simplify interactions with user provided syslog drains.

Installing Plugin

From CF-Community

nstall-plugin -r CF-Community "drains"

From Binary Release

1. Download the binary for the latest release for your platform.
2. Install it into the cf cli:

nstall-plugin download/path/cf-drain-cli

From Source Code

Make sure to have the latest Go toolchain installed.

et code.cloudfoundry.org/cf-drain-cli
nstall-plugin $GOPATH/bin/cf-drain-cli

Usage

Create Drain

 drain --help
:
rain - Creates a user provided service for syslog drains and binds it to a given application.

E:
rain <app-name> <syslog-drain-url> [options]

ONS:
-drain-name         The name of the drain that will be created. If excluded, the drain name will be `cf-drain-UUID`.
-type               The type of logs to be sent to the syslog drain. Available types: `logs`, `metrics`, and `all`. Default is `logs`

Delete Drain

 delete-drain --help
:
elete-drain - Unbinds the service from applications and deletes the
ice.

E:
elete-drain <drain-name>

Bind Drain

 bind-drain --help
:
ind-drain - Binds an application to an existing syslog drain.

E:
ind-drain <app-name> <drain-name>

List Drains

 drains --help
:
rains - Lists all services for syslog drains.

E:
rains

Space Drain (Experimental)

Note: The space drain functionality is an experimental feature. It can create additional load in large deployments because it binds every app in the space to a drain. Be sure to consider your deployment size when deciding whether to use a full space drain.

:
rain-space - Pushes app to bind all apps in the space to the configured syslog drain

E:
rain-space [OPTIONS]

ONS:
-drain-name               Name for the space drain. Required
-drain-url                Syslog endpoint for the space drain. Required
-force                    Skip warning prompt. Default is false
-path                     Path to the space drain app to push. If omitted the latest release will be downloaded
-type                     Which log type to filter on (logs, metrics, all). Default is all
-username                 Username to use when pushing the app. If not specified, a user will be created (requires admin permissions)