schemahero

module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 30, 2019 License: Apache-2.0

README

SchemaHero

Go Report Card Coverage Build Status Godoc LICENSE

Note: This is a work-in-progress that is not yet functional. SchemaHero is a an experiment right now, and does not have enough implementation to be used in any environment. Work is in progress.

What is SchemaHero?

SchemaHero is a Kubernetes Operator for Declarative Schema Management for various databases. SchemaHero has the following goals:

  1. Database tables can be expressed as Kubernetes resources that can be updated and deployed to the cluster.
  2. Database migrations can be written as SQL statements, expressed as Kubernetes resources that can be deployed to the cluster.
  3. Database schemas can be monitored for drift and brought back to the desired state automatically.
  4. Schemas and migations can require other schemas or migrations instead of ordering with timestamps and/or sequences.

Getting Started

The recommended way to deploy SchemaHero is:

kubectl apply -f https://raw.githubusercontent.com/schemahero/schemahero/master/install/schemahero/schemahero-operator.yaml

To get started, read our tutorial and the how to use guide

Directories

Path Synopsis
cmd
integration
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/v1alpha1
Package v1alpha1 contains API Schema definitions for the databases v1alpha1 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 v1alpha1 contains API Schema definitions for the databases v1alpha1 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 v1alpha1 contains API Schema definitions for the databases v1alpha1 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 v1alpha1 contains API Schema definitions for the databases v1alpha1 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/v1alpha1
Package v1alpha1 contains API Schema definitions for the schemas v1alpha1 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 v1alpha1 contains API Schema definitions for the schemas v1alpha1 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 v1alpha1 contains API Schema definitions for the schemas v1alpha1 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 v1alpha1 contains API Schema definitions for the schemas v1alpha1 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
cli
client/schemaheroclientset
This package has the automatically generated clientset.
This package has the automatically generated 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/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/schemaheroclientset/typed/databases/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
client/schemaheroclientset/typed/schemas/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/schemaheroclientset/typed/schemas/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL