README
¶
What is SchemaHero?
SchemaHero is a Kubernetes Operator for Declarative Schema Management for various databases. SchemaHero has the following goals:
- Database table schemas can be expressed as Kubernetes resources that can be deployed to a cluster.
- Database schemas can be edited and deployed to the cluster. SchemaHero will calculate the required change (
ALTER TABLEstatement) and apply it. - SchemaHero can manage databases that are deployed to the cluster, or external to the cluster (RDS, Google CloudSQL, etc).
Getting Started
The recommended way to deploy SchemaHero is to use the kubectl plugin. Full instruction and other installation methods listed in the documentation.
To get started, read the tutorial and the full documentation
Community
For questions about using SchemaHero, there's a Replicated Community forum, and a #schemahero channel in Kubernetes Slack. If you are interested in contributing to Schemahero, you can find more information on how to get started on our Community page.
If you're a user of SchemaHero, add yourself to the ADOPTERS file!
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
kubectl-schemahero
command
|
|
|
manager
command
|
|
|
pkg
|
|
|
apis
Package apis contains Kubernetes API groups.
|
Package apis contains Kubernetes API groups. |
|
apis/databases
Package databases contains databases API versions
|
Package databases contains databases API versions |
|
apis/databases/v1alpha4
package v1alpha4 contains API Schema definitions for the databases v1alpha4 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/schemahero/schemahero/pkg/apis/databases +k8s:defaulter-gen=TypeMeta +groupName=databases.schemahero.io
|
package v1alpha4 contains API Schema definitions for the databases v1alpha4 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/schemahero/schemahero/pkg/apis/databases +k8s:defaulter-gen=TypeMeta +groupName=databases.schemahero.io |
|
apis/schemas
Package schemas contains schemas API versions
|
Package schemas contains schemas API versions |
|
apis/schemas/v1alpha4
package v1alpha4 contains API Schema definitions for the schemas v1alpha4 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/schemahero/schemahero/pkg/apis/schemas +k8s:defaulter-gen=TypeMeta +groupName=schemas.schemahero.io
|
package v1alpha4 contains API Schema definitions for the schemas v1alpha4 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/schemahero/schemahero/pkg/apis/schemas +k8s:defaulter-gen=TypeMeta +groupName=schemas.schemahero.io |
|
client/schemaheroclientset
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/schemaheroclientset/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/schemaheroclientset/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/schemaheroclientset/typed/databases/v1alpha4
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/schemaheroclientset/typed/databases/v1alpha4/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
client/schemaheroclientset/typed/schemas/v1alpha4
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/schemaheroclientset/typed/schemas/v1alpha4/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
plugins
|
|
|
cassandra
module
|
|
|
mysql
module
|
|
|
postgres
module
|
|
|
rqlite
module
|
|
|
sqlite
module
|
|
|
timescaledb
module
|
Click to show internal directories.
Click to hide internal directories.