cloudfoundry/cfdot

Name: cfdot

Owner: Cloud Foundry

Description: A command-line tool to interact with a Cloud Foundry Diego deployment.

Created: 2016-07-13 18:46:20.0

Updated: 2018-05-07 13:59:06.0

Pushed: 2018-05-17 19:56:10.0

Homepage:

Size: 262

Language: Go

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

cfdot

cfdot is the CF Diego Operator Toolkit, a CLI tool designed to interact with Diego components.

At present, its commands focus on the Diego BBS API, the main public interface to a Diego deployment.

Current Commands

dot --help
mmand-line tool to interact with a Cloud Foundry Diego deployment

e:
dot [command]

lable Commands:
tual-lrp-groups            List actual LRP groups
tual-lrp-groups-for-guid   List actual LRP groups for a process guid
ncel-task                  Cancel task
ll                         Show the specified cell presence
ll-state                   Show the specified cell state
ll-states                  Show cell states for all cells
lls                        List registered cell presences
aim-lock                   Claim Locket lock
aim-presence               Claim Locket presence
eate-desired-lrp           Create a desired LRP
eate-task                  Create a Task
lete-desired-lrp           Delete a desired LRP
lete-task                  Delete a Task
sired-lrp                  Show the specified desired LRP
sired-lrp-scheduling-infos List desired LRP scheduling infos
sired-lrps                 List desired LRPs
mains                      List domains
lp                         Get help on [command]
cks                        List Locket locks
p-events                   Subscribe to BBS LRP events
esences                    List Locket presences
lease-lock                 Release Locket lock
tire-actual-lrp            Retire actual LRP by index and process guid
t-domain                   Set domain
sk                         Display task
sk-events                  Subscribe to BBS Task events
sks                        List tasks in BBS
date-desired-lrp           Update a desired LRP

s:
, --help   help for cfdot

"cfdot [command] --help" for more information about a command.

Running from a BOSH-deployed VM

cfdot is most useful in the context of a running Diego deployment. If you use the generate-deployment-manifest script in diego-release to generate your Diego manifest, cfdot is already available on the BOSH-deployed Diego VMs. To use it:

 ssh <DIEGO_JOB>/<INDEX>
t

The cfdot pre-start script installs the setup script into /etc/profile.d. This setup script does 3 things:

• Exports environment variables to target the BBS API in the deployment.
• Puts the cfdot binary on the PATH.
• Puts a jq binary on the PATH.

Basic Examples

unt the total number of desired instances
dot desired-lrp-scheduling-infos | jq '.instances' | jq -s 'add'


ow instance counts by state
dot actual-lrp-groups | jq '.instance, .evacuating | values' | jq -s -r 'group_by(.state)[] | .[0].state + ": " + (length | tostring)'
HED: 36
ING: 531
AIMED: 1

Building from Source

cfdot requires the Diego BBS client library. If you have already cloned diego-release, you can run the following commands using that diego-release directory as your GOPATH. Alternatively, run these commands with any other GOPATH and go get will automatically fetch the latest BBS code from diego-release.

t cfdot and required dependencies
et code.cloudfoundry.org/cfdot
rc/code.cloudfoundry.org/cfdot

ild for Linux
=linux go build .

ild for Mac
=darwin go build .

ild for Windows
=windows go build .

Design Tenets

• Execution is stateless: configuration is specified either as flags or as environment variables.
• Conform to UNIX conventions of successful output on stdout and error messages on stderr.
• For BBS API commands, output is a stream of JSON values, one per line, optimal for processing with jq and suitable for processing with bash and other line-based UNIX utilities.