• Stars
    star
    254
  • Rank 151,402 (Top 4 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created over 5 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Apache Cassandra cluster orchestration tool for the command line

cstar

CircleCI License

cstar is an Apache Cassandra cluster orchestration tool for the command line.

asciicast

Why not simply use Ansible or Fabric?

Ansible does not have the primitives required to run things in a topology aware fashion. One could split the C* cluster into groups that can be safely executed in parallel and run one group at a time. But unless the job takes almost exactly the same amount of time to run on every host, such a solution would run with a significantly lower rate of parallelism, not to mention it would be kludgy enough to be unpleasant to work with.

Unfortunately, Fabric is not thread safe, so the same type of limitations apply. Fabric allows one to run a job in parallel on many machines, but with similar restrictions as those of Ansible groups. It’s possibly to use fabric and celery together to do what is needed, but it’s a very complicated solution.

Requirements

All involved machines are assumed to be some sort of UNIX-like system like OS X or Linux. The machine running cstar must have python3, the Cassandra hosts must have a Bourne style shell.

Installing

You need to have Python3 and run an updated version of pip (9.0.1).

# pip3 install cstar

It's also possible to install straight from repo. This installs the latest version that may not be pushed to pypi:

# pip install git+https://github.com/spotify/cstar.git

Code of conduct

This project adheres to the Open Code of Conduct. By participating, you are expected to honor this code.

CLI

CStar is run through the cstar command, like so

# cstar COMMAND [HOST-SPEC] [PARAMETERS]

The HOST-SPEC specifies what nodes to run the script on. There are three ways to specify a the spec:

  1. The --seed-host switch tells cstar to connect to a specific host and fetch the full ring topology from there, and then run the script on all nodes in the cluster. --seed-host can be specified multiple times, and multiple hosts can be specified as a comma-separated list in order to run a script across multiple clusters.
  2. The --host switch specifies an exact list of hosts to use. --host can be specified multiple times, and multiple hosts can be specified as a comma-separated list.
  3. The --host-file switch points to a file name containing a newline separated list of hosts. This can be used together with process substitution, e.g. --host-file <(dig -t srv ...)

The command is the name of a script located in either /usr/lib/cstar/commands or in ~/.cstar/commands. This script will be uploaded to all nodes in the cluster and executed. File suffixes are stripped. The requirements of the script are described below. Cstar comes pre-packaged with one script file called run which takes a single parameter --command - see examples below.

Some additional switches to control cstar:

  • One can override the parallelism specified in a script by setting the switches --cluster-parallel, --dc-parallel and --strategy.

There are two special case invocations:

  • One can skip the script name and instead use the continue command to specify a previously halted job to resume.

  • One can skip the script name and instead use the cleanup-jobs. See Cleaning up old jobs.

  • If you need to access the remote cluster with a specific username, add --ssh-username=remote_username to your cstar command line. A private key file can also be specified using --ssh-identity-file=my_key_file.pem.

  • To use plain text authentication, please add --ssh-password=my_password to the command line.

  • In order to run the command first on a single node and then stop execution to verify everything worked as expected, add the following flag to your command line : --stop-after=1. cstar will stop after the first node executed the command and print out the appropriate resume command to continue the execution when ready : cstar continue <JOB_ID>

A script file can specify additional parameters.

Command syntax

In order to run a command, it is first uploaded to the relevant host, and then executed from there.

Commands can be written in any scripting language in which the hash symbol starts a line comment, e.g. shell-script, python, perl or ruby.

The first line must be a valid shebang. After that, commented lines containing key value pairs may be used to override how the script is parallelised as well as providing additional parameters for the script, e.g. # C* dc-parallel: true

The possible keys are:

cluster-parallel, can the script be run on multiple clusters in parallel. Default value is true.

dc-parallel, can the script be run on multiple data centers in the same cluster in parallel. Default value is false.

strategy, how many nodes within one data center can the script be run on. Default is topology. Can be one of:

  • one, only one node per data center
  • topology, inspect topology and run on as many nodes as the topology allows
  • all, can be run on all nodes at once

description, specifies a description for the script used in the help message.

argument, specifies an additional input parameter for the script, as well as a help text and an optional default value.

Job output

Cstar automatically saves the job status to file during operation.

Standard output, standard error and exit status of each command run against a Cassandra host is saved locally on machine where cstar is running. They are available under the users home directory in .cstar/jobs/JOB_ID/HOSTNAME

How jobs are run

When a new cstar job is created, it is assigned an id. (It's a UUID)

Cstar stores intermediate job output in the directory ~/.cstar/remote_jobs/<JOB_ID>. This directory contains files with the stdout, stderr and PID of the script, and once it finishes, it will also contain a file with the exit status of the script.

Once the job finishes, these files will be moved over to the original host and put in the directory ~/.cstar/jobs/<JOB_ID>/<REMOTE_HOST_NAME>.

Cstar jobs are run nohuped, this means that even if the ssh connection is severed, the job will proceed. In order to kill a cstar script invocation on a specific host, you will need ssh to the host and kill the proccess.

If a job is halted half-way, either by pressing ^C or by using the --stop-after parameter, it can be restarted using cstar continue <JOB_ID>. If the script was finished or already running when cstar shut down, it will not be rerun.

Cleaning up old jobs

Even on successful completion, the output of a cstar job is not deleted. This means it's easy to check what the output of a script was after it completed. The downside of this is that you can get a lot of data lying around in ~/.cstar/jobs. In order to clean things up, you can use cstar cleanup-jobs. By default it will remove all jobs older than one week. You can override the maximum age of a job before it's deleted by using the --max-job-age parameter.

Examples

# cstar run --command='service cassandra restart' --seed-host some-host

Explanation: Run the local cli command service cassandra restart on a cluster. If necessary, add sudo to the command.

# cstar puppet-upgrade-cassandra --seed-host some-host --puppet-branch=cass-2.2-upgrade

Explanation: Run the command puppet-upgrade-cassandra on a cluster. The puppet-upgrade-cassandra command expects a parameter, the puppet branch to run in order to perform the Cassandra upgrade. See the puppet-upgrade-cassandra example below.

# cstar puppet-upgrade-cassandra --help

Explanation: Show help for the puppet-upgrade-cassandra command. This includes documentation for any additional command-specific switches for the puppet-upgrade-cassandra command.

# cstar continue 90642c11-4714-44c4-a13a-94b86f09e3bb

Explanation: Resume previously created job with job id 90642c11-4714-44c4-a13a-94b86f09e3bb. The job id is the first line written on any executed job.

Example script file

This is an example script file that would saved to ~/.cstar/commands/puppet-upgrade-cassandra.sh. It upgrades a Cassandra cluster by running puppet on a different branch, then restarting the node, then upgrading the sstables.

# !/usr/bin/env bash
# C* cluster-parallel: true                                                                                                                                                                                    
# C* dc-parallel: true                                                                                                                                                                                         
# C* strategy: topology                                                                                                                                                                                        
# C* description: Upgrade one or more clusters by switching to a different puppet branch                                                                                                                       
# C* argument: {"option":"--snapshot-name", "name":"SNAPSHOT_NAME", "description":"Name of pre-upgrade snapshot", "default":"preupgrade"}                                                                      
# C* argument: {"option":"--puppet-branch", "name":"PUPPET_BRANCH", "description":"Name of puppet branch to switch to", "required":true}                                                                       

nodetool snapshot -t $SNAPSHOT_NAME
sudo puppet --branch $PUPPET_BRANCH
sudo service cassandra restart
nodetool upgradesstables

More Repositories

1

luigi

Luigi is a Python module that helps you build complex pipelines of batch jobs. It handles dependency resolution, workflow management, visualization etc. It also comes with Hadoop support built in.
Python
17,089
star
2

annoy

Approximate Nearest Neighbors in C++/Python optimized for memory usage and loading/saving to disk
C++
12,458
star
3

docker-gc

INACTIVE: Docker garbage collection of containers and images
Shell
5,068
star
4

pedalboard

🎛 🔊 A Python library for working with audio.
C++
4,748
star
5

chartify

Python library that makes it easy for data scientists to create charts.
Python
3,447
star
6

basic-pitch

A lightweight yet powerful audio-to-MIDI converter with pitch bend detection
Python
2,759
star
7

dockerfile-maven

MATURE: A set of Maven tools for dealing with Dockerfiles
Java
2,730
star
8

docker-maven-plugin

INACTIVE: A maven plugin for Docker
Java
2,652
star
9

scio

A Scala API for Apache Beam and Google Cloud Dataflow.
Scala
2,485
star
10

helios

Docker container orchestration platform
Java
2,097
star
11

web-api-examples

Basic examples to authenticate and fetch data using the Spotify Web API
HTML
1,889
star
12

HubFramework

DEPRECATED – Spotify’s component-driven UI framework for iOS
Objective-C
1,864
star
13

apollo

Java libraries for writing composable microservices
Java
1,648
star
14

dh-virtualenv

Python virtualenvs in Debian packages
Python
1,590
star
15

docker-client

INACTIVE: A simple docker client for the JVM
Java
1,425
star
16

docker-kafka

Kafka (and Zookeeper) in Docker
Shell
1,397
star
17

SPTPersistentCache

Everyone tries to implement a cache at some point in their iOS app’s lifecycle, and this is ours.
Objective-C
1,244
star
18

mobius

A functional reactive framework for managing state evolution and side-effects.
Java
1,196
star
19

sparkey

Simple constant key/value storage library, for read-heavy systems with infrequent large bulk inserts.
C
1,143
star
20

ruler

Gradle plugin which helps you analyze the size of your Android apps.
Kotlin
1,094
star
21

voyager

🛰️ Voyager is an approximate nearest-neighbor search library for Python and Java with a focus on ease of use, simplicity, and deployability.
C++
1,090
star
22

XCMetrics

XCMetrics is the easiest way to collect Xcode build metrics and improve developer productivity.
Swift
1,070
star
23

web-api

This issue tracker is no longer used. Join us in the Spotify for Developers forum for support with the Spotify Web API ➡️ https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer
RAML
981
star
24

echoprint-codegen

Codegen for Echoprint
C++
948
star
25

snakebite

A pure python HDFS client
Python
859
star
26

heroic

The Heroic Time Series Database
Java
843
star
27

klio

Smarter data pipelines for audio.
Python
825
star
28

XCRemoteCache

Swift
816
star
29

SPTDataLoader

The HTTP library used by the Spotify iOS client
Objective-C
624
star
30

apps-tutorial

A Spotify App that contains working examples of the use of Spotify Apps API
624
star
31

ios-sdk

Spotify SDK for iOS
Objective-C
609
star
32

JniHelpers

Tools for writing great JNI code
C++
584
star
33

postgresql-metrics

Tool that extracts and provides metrics on your PostgreSQL database
Python
583
star
34

reactochart

📈 React chart component library 📉
JavaScript
546
star
35

Mobius.swift

A functional reactive framework for managing state evolution and side-effects [Swift implementation]
Swift
539
star
36

dockerfile-mode

An emacs mode for handling Dockerfiles
Emacs Lisp
517
star
37

threaddump-analyzer

A JVM threaddump analyzer
JavaScript
481
star
38

featran

A Scala feature transformation library for data science and machine learning
Scala
467
star
39

android-sdk

Spotify SDK for Android
HTML
440
star
40

echoprint-server

Server for the Echoprint audio fingerprint system
Java
398
star
41

web-scripts

DEPRECATED: A collection of base configs and CLI wrappers used to speed up development @ Spotify.
TypeScript
382
star
42

completable-futures

Utilities for working with futures in Java 8
Java
378
star
43

SpotifyLogin

Swift framework for authenticating with the Spotify API
Swift
344
star
44

ratatool

A tool for data sampling, data generation, and data diffing
Scala
334
star
45

fmt-maven-plugin

Opinionated Maven Plugin that formats your Java code.
Java
299
star
46

big-data-rosetta-code

Code snippets for solving common big data problems in various platforms. Inspired by Rosetta Code
Scala
286
star
47

trickle

A small library for composing asynchronous code
Java
284
star
48

coordinator

A visual interface for turning an SVG into XY coördinates.
HTML
282
star
49

pythonflow

🐍 Dataflow programming for python.
Python
279
star
50

styx

"The path to execution", Styx is a service that schedules batch data processing jobs in Docker containers on Kubernetes.
Java
267
star
51

netty-zmtp

A Netty implementation of ZMTP, the ZeroMQ Message Transport Protocol.
Java
242
star
52

ios-style

Guidelines for iOS development in use at Spotify
240
star
53

cassandra-reaper

Software to run automated repairs of cassandra
234
star
54

confidence

Python
232
star
55

spotify-web-api-ts-sdk

A Typescript SDK for the Spotify Web API with types for returned data.
TypeScript
231
star
56

docker-cassandra

Cassandra in Docker with fast startup
Shell
218
star
57

terraform-gke-kubeflow-cluster

Terraform module for creating GKE clusters to run Kubeflow
HCL
209
star
58

linux

Spotify's Linux kernel for Debian-based systems
C
203
star
59

git-test

test your commits
Shell
202
star
60

dns-java

DNS wrapper library that provides SRV lookup functionality
Java
201
star
61

SPStackedNav

[DEPRECATED] Navigation controller which represents its content in stacks of panes, rather than one at a time
Objective-C
195
star
62

basic-pitch-ts

A lightweight yet powerful audio-to-MIDI converter with pitch bend detection.
TypeScript
194
star
63

quickstart

A CommonJS module resolver, loader and compiler for node.js and browsers.
JavaScript
192
star
64

spotify-json

Fast and nice to use C++ JSON library.
C++
188
star
65

dbeam

DBeam exports SQL tables into Avro files using JDBC and Apache Beam
Java
181
star
66

flink-on-k8s-operator

Kubernetes operator for managing the lifecycle of Apache Flink and Beam applications.
Go
178
star
67

bazel-tools

Tools for dealing with very large Bazel-managed repositories
Java
165
star
68

lingon

A user friendly tool for building single-page JavaScript applications
JavaScript
162
star
69

dataenum

Algebraic data types in Java.
Java
159
star
70

async-google-pubsub-client

[SUNSET] Async Google Pubsub Client
Java
157
star
71

magnolify

A collection of Magnolia add-on modules
Scala
157
star
72

gcp-audit

A tool for auditing security properties of GCP projects.
Python
156
star
73

spark-bigquery

Google BigQuery support for Spark, SQL, and DataFrames
Scala
154
star
74

flo

A lightweight workflow definition library
Java
146
star
75

folsom

An asynchronous memcache client for Java
Java
144
star
76

should-up

Remove most of the "should" noise from your tests
JavaScript
143
star
77

missinglink

Build time tool for detecting link problems in java projects
Java
141
star
78

zoltar

Common library for serving TensorFlow, XGBoost and scikit-learn models in production.
Java
141
star
79

android-auth

Spotify authentication and authorization for Android. Part of the Spotify Android SDK.
HTML
139
star
80

proto-registry

An implementation of the Protobuf Registry API
TypeScript
139
star
81

futures-extra

Java library for working with Guava futures
Java
136
star
82

annoy-java

Approximate nearest neighbors in Java
Java
134
star
83

spydra

Ephemeral Hadoop clusters using Google Compute Platform
Java
132
star
84

docker-stress

Simple docker stress test and monitoring tools
Python
124
star
85

spotify-tensorflow

Provides Spotify-specific TensorFlow helpers
Python
123
star
86

spotify-web-playback-sdk-example

React based example app that creates a new player in Spotify Connect to play music from in the browse using Spotify Web Playback SDK.
JavaScript
120
star
87

crtauth

a public key backed client/server authentication system
Python
119
star
88

sparkey-java

Java implementation of the Sparkey key value store
Java
117
star
89

redux-location-state

Utilities for reading & writing Redux store state to & from the URL
JavaScript
117
star
90

rspec-dns

Easily test your DNS with RSpec
Ruby
108
star
91

web-playback-sdk

This issue tracker is no longer used. Join us in the Spotify for Developers forum for support with the Spotify Web Playback SDK ➡️ https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer
108
star
92

ffwd-ruby

An event and metrics fast-forwarding agent.
Ruby
106
star
93

realbook

Easier audio-based machine learning with TensorFlow.
Python
106
star
94

github-java-client

A Java client to Github API
Java
105
star
95

gimme

Creating time bound IAM Conditions with ease and flair
Python
103
star
96

super-smash-brogp

Sends and withdraws BGP prefixes for fun.
Python
98
star
97

lighthouse-audit-service

TypeScript
93
star
98

noether

Scala Aggregators used for ML Model metrics monitoring
Scala
91
star
99

python-graphwalker

Python re-implementation of the graphwalker testing tool
Python
90
star
100

spotify-js-challenge

JavaScript
87
star