Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Non consistent naming of PartitionSet/PartitionGroup #8

Open
stolsma opened this issue Mar 16, 2020 · 0 comments
Open

Non consistent naming of PartitionSet/PartitionGroup #8

stolsma opened this issue Mar 16, 2020 · 0 comments

Comments

@stolsma
Copy link

stolsma commented Mar 16, 2020

Small nit...

The main README.md text and pictures are not consistent regarding PartitionSet/PartitionGroup naming. It makes it very difficult to understand the flow of actions... Could the pictures or the text be changed to reflect the correct naming?

Its the part below the 'How it works' line. Specifically the following text and corresponding diagram:

"The Atomix controller provides two custom Kubernetes controllers for managing partition groups and partitions. When a partition group is created via the Atomix controller API, the Atomix controller creates a PartitionSet resource, and the remainder of the deployment process is managed by custom Kubernetes controllers. The PartitionSet controller creates a set of Partition resources from the PartitionSet, and the Partition controller creates StatefulSet resources, Services, and other resources necessary to run the protocol specified by the PartitionSet configuration."

Thanks!!

Could have make a pull request but I don't have access to the original picture...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant