https://github.com/authzed/spicedb-operator

Kubernetes controller for managing instances of SpiceDB
https://github.com/authzed/spicedb-operator

authorization authzed database database-management distributed distributed-systems fine-grained-authorization go golang graph-database kubernetes kubernetes-controller kubernetes-operator permissions production scale security security-tools spicedb zanzibar

Last synced: 12 days ago
JSON representation

Kubernetes controller for managing instances of SpiceDB

• Host: GitHub
• URL: https://github.com/authzed/spicedb-operator
• Owner: authzed
• License: apache-2.0
• Created: 2022-05-11T18:23:35.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-03T07:41:34.000Z (25 days ago)
• Last Synced: 2024-06-04T14:48:56.659Z (24 days ago)
• Topics: authorization, authzed, database, database-management, distributed, distributed-systems, fine-grained-authorization, go, golang, graph-database, kubernetes, kubernetes-controller, kubernetes-operator, permissions, production, scale, security, security-tools, spicedb, zanzibar
• Language: Go
• Size: 1.58 MB
• Stars: 59
• Watchers: 5
• Forks: 24
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE-OF-CONDUCT.md
  • Codeowners: CODEOWNERS

Lists

• awesome-spicedb - SpiceDB Operator - Official Kubernetes Operator for running SpiceDB (Developer Tools / Official Tools)

README

        
# SpiceDB Operator

[![Container Image](https://img.shields.io/github/v/release/authzed/spicedb-operator?color=%232496ED&label=container&logo=docker "Container Image")](https://hub.docker.com/r/authzed/spicedb-operator/tags)

[![Docs](https://img.shields.io/badge/docs-authzed.com-%234B4B6C "Authzed Documentation")](https://docs.authzed.com)

[![Build Status](https://github.com/authzed/spicedb-operator/workflows/Build%20&%20Test/badge.svg "GitHub Actions")](https://github.com/authzed/spicedb-operator/actions)

[![Discord Server](https://img.shields.io/discord/844600078504951838?color=7289da&logo=discord "Discord Server")](https://discord.gg/jTysUaxXzM)

[![Twitter](https://img.shields.io/twitter/follow/authzed?color=%23179CF0&logo=twitter&style=flat-square "@authzed on Twitter")](https://twitter.com/authzed)

A [Kubernetes operator] for managing [SpiceDB] clusters.

Features include:

- Creation, management, and scaling of SpiceDB clusters with a single [Custom Resource]

- Automated datastore migrations when upgrading SpiceDB versions

Have questions? Join our [Discord].

Looking to contribute? See [CONTRIBUTING.md].

[Kubernetes operator]: https://kubernetes.io/docs/concepts/extend-kubernetes/operator/

[SpiceDB]: https://github.com/authzed/spicedb

[Custom Resource]: https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/

[Discord]: https://authzed.com/discord

[CONTRIBUTING.md]: CONTRIBUTING.md

## Getting Started

In order to get started, you'll need a Kubernetes cluster.

For local development, install your tool of choice.

You can use whatever, so long as you're comfortable with it and it works on your platform.

We recommend one of the following:

- [Docker Desktop](https://www.docker.com/products/docker-desktop/)

- [kind](https://kind.sigs.k8s.io)

- [minikube](https://minikube.sigs.k8s.io)

Next, you'll install a [release](https://github.com/authzed/spicedb-operator/releases/) of the operator:

```console

kubectl apply --server-side -f https://github.com/authzed/spicedb-operator/releases/latest/download/bundle.yaml

```

Finally you can create your first cluster:

```console

kubectl apply --server-side -f - <