Skip to content

Commit

Permalink
readme: readme improvements
Browse files Browse the repository at this point in the history
Added badges
Added EKS links
Refreshed supported features
Changed slack channel name
Refreshed build guideline

Fixes #83
  • Loading branch information
zimnx committed Jan 4, 2021
1 parent 92d3325 commit 3b6ece8
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
@@ -1,5 +1,12 @@
# Scylla Operator
> Kubernetes Operator for Scylla (Beta version :warning:)


[![LICENSE](https://img.shields.io/github/license/scylladb/scylla-operator.svg)](https://github.com/scylladb/scylla-operator/blob/master/LICENSE)
[![Language](https://img.shields.io/badge/Language-Go-blue.svg)](https://golang.org/)
[![Go Report Card](https://goreportcard.com/badge/github.com/scylladb/scylla-operator)](https://goreportcard.com/report/github.com/scylladb/scylla-operator)
[![GitHub release](https://img.shields.io/github/tag/scylladb/scylla-operator.svg?label=release)](https://github.com/scylladb/scylla-operator/releases)

[Scylla Operator](https://github.com/scylladb/scylla-operator) is a Kubernetes Operator for managing and automating tasks related to managing a Scylla clusters.

[Scylla](https://www.scylladb.com) is a close-to-the-hardware rewrite of Cassandra in C++. It features a shared nothing architecture that enables true linear scaling and major hardware optimizations that achieve ultra-low latencies and extreme throughput. It is a drop-in replacement for Cassandra and uses the same interfaces.

Expand All @@ -11,41 +18,45 @@ To quickly deploy a Scylla cluster, choose one of the following options:

* [Generic](docs/source/generic.md): Follow this guide for the general way to use the operator.
* [GKE](docs/source/gke.md): An advanced guide for deploying Scylla with the best performance settings on [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine).
* [EKS](docs/source/eks.md): An advanced guide for deploying Scylla with the best performance settings on [Amazon Elastic Kubernetes Service](https://aws.amazon.com/eks/).

## Description

Scylla Operator is in **Beta** status.
> Kubernetes Operator for Scylla
The scylla-operator is a Kubernetes Operator for managing Scylla clusters. Currently it supports:
Currently it supports:
* Deploying multi-zone clusters
* Scaling up or adding new racks
* Scaling down
* Monitoring with Prometheus and Grafana

Future additions include:
* Integration with [Scylla Manager](https://docs.scylladb.com/operating-scylla/manager/)
* Dead node replacement
* Version Upgrade
* Backup
* Repairs
* Autohealing

Future additions include:
* Restore


## Top-Performance Setup

Scylla performs the best when it has fast disks and direct access to the CPU. To deploy Scylla with maximum performance, follow the guide for your environment:
* [GKE](docs/source/gke.md)
* [EKS](docs/source/eks.md)


## Bugs

If you find a bug or need help running scylla, you can reach out in the following ways:
* `#kubernetes` channel on [Slack](https://scylladb-users-slackin.herokuapp.com/).
* `#scylla-operator` channel on [Slack](https://scylladb-users-slackin.herokuapp.com/).
* File an [issue](https://github.com/scylladb/scylla-operator/issues) describing the problem and how to reproduce.

## Building the project

You can easily build Scylla Operator in your environment:
* Open the Makefile and change the `IMG` environment variable to a repository you have access to.
* Run `make publish` and wait for the image to be built and uploaded in your repo.
* Run `make docker-build` and wait for the image to be built.

## Contributing

Expand Down

0 comments on commit 3b6ece8

Please sign in to comment.