https://github.com/softprops/scuttlebutt

Listen in on all the gossip going on in your kubernetes cluster :speak_no_evil:
https://github.com/softprops/scuttlebutt

Last synced: 8 months ago
JSON representation

Listen in on all the gossip going on in your kubernetes cluster :speak_no_evil:

• Host: GitHub
• URL: https://github.com/softprops/scuttlebutt
• Owner: softprops
• License: mit
• Created: 2016-08-29T05:43:53.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-11-08T07:35:43.000Z (over 8 years ago)
• Last Synced: 2025-02-01T06:31:44.080Z (over 1 year ago)
• Language: Rust
• Homepage:
• Size: 572 KB
• Stars: 12
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# scuttlebutt [![Build Status](https://travis-ci.org/softprops/scuttlebutt.svg?branch=master)](https://travis-ci.org/softprops/scuttlebutt) [![Coverage Status](https://coveralls.io/repos/github/softprops/scuttlebutt/badge.svg)](https://coveralls.io/github/softprops/scuttlebutt) [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE) [![crates.io](http://meritbadge.herokuapp.com/scuttlebutt)](https://crates.io/crates/scuttlebutt)

> Listen in on all the gossip going on in your [kubernetes](http://kubernetes.io/) cluster

[Documentation](https://softprops.github.io/scuttlebutt)

## install

Add the following to your Cargo.toml file

```toml

[dependencies]

scuttlebutt = "0.2"

```

## usage

Central to scuttlebutt is a cluster. Clusters provide an interface for feeding off of kubernetes events

via a [Receiver](https://doc.rust-lang.org/std/sync/mpsc/struct.Receiver.html).

The default use case is to connect to a kubernetes cluster behind [kube-proxy](http://kubernetes.io/docs/admin/kube-proxy/). This interface may be extended to run

outside a cluster with a set of [kubeconfig credentials](https://github.com/softprops/kubecfg) in the future.

```rust

extern crate scuttlebutt;

use scuttlebutt::{Cluster, Events};

fn main() {

    match Cluster::new().events() {

           Ok(events) => {

               for e in events.into_iter() {

                   println!("{:#?}", e)

               }

           }

           Err(e) => println!("{:#?}", e),

       }

}

```

Doug Tangren (softprops) 2016-2017