Git Product home page Git Product logo

schemahero-docs's Introduction

SchemaHero


Go Report Card Godoc LICENSE

What is SchemaHero?

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

  1. Database table schemas can be expressed as Kubernetes resources that can be deployed to a cluster.
  2. Database schemas can be edited and deployed to the cluster. SchemaHero will calculate the required change (ALTER TABLE statement) and apply it.
  3. 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!

schemahero-docs's People

Contributors

0xflotus avatar andyli avatar breezybaldwin avatar chase-replicated avatar danstough avatar divolgin avatar dzsquared avatar emosbaugh avatar ghuntley avatar grantmiller avatar graysonnull avatar jala-dx avatar jgruica avatar jonquil2002 avatar laverya avatar log2 avatar marccampbell avatar maufranchini avatar mclavel avatar ogtrilliams avatar osc135 avatar philips avatar theswerd avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

schemahero-docs's Issues

Investigate mkdocs material theme

The current docs are a little difficult to navigate. If we moved to the mkdocs material theme, we could speed up the build process and flatten the navigation.

Other recent CNCF projects have adopted this, and it's not too different from what we have now.

Example:
https://docs.tinkerbell.org

Doc to compare jobs vs SchemaHero

The default choice to write and deploy database migrations in Kubernetes is to wrap them in a Job. This approach has some drawbacks, and SchemaHero docs could explain this to help show the value in the operator approach.

  • Transparency in debugging
  • Sequencing
  • Tightly coupling database migrations with an app migration
  • ???

Add CODEOWNERS file.

Suggestion:
Add a CODEOWNERS file to get reviewers assigned. I've had a PR sitting for months. These are PRs that likely come from people trying to adopt SchemaHero and are trying to help others get past documentation blockers.

I've seen a dupe #73 of #56 get merged recently and I'm confused about how that happened.

Take care!

Merge docs into the schemahero repo?

Right now, docs are a little difficult to manage with the release cycle.

If the docs were merged into the schemahero repo, and published on tag/release, then we could more easily stage the docs.

What best practices or recommendations exist for this?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.