search

Orange-OpenSource / casskop

This Kubernetes operator automates the Cassandra operations such as deploying a new rack aware cluster, adding/removing nodes, configuring the C* and JVM parameters, upgrading JVM and C* versions, and many more...
https://orange-opensource.github.io/casskop/
Apache License 2.0
183 stars 54 forks source link

Update Documentation #361

Closed PERES-Richard closed 3 years ago

PERES-Richard commented 3 years ago
Q A
Bug fix? []
New feature? []
API breaks? []
Deprecations? []
License Apache 2.0

What's in this PR?

Some fixes and comments to keep the doc updated.

PERES-Richard commented 3 years ago

https://github.com/Orange-OpenSource/casskop/pull/361/files#R29

Remove the "alpha project production not ready" mention ?

DONE

PERES-Richard commented 3 years ago

https://github.com/Orange-OpenSource/casskop/pull/361/files#R47

Remove the old slides presentation of CassKop to avoid conflict ? Or add a tag "DEPRECIATED" for example ?

TODO ? @cscetbon

PERES-Richard commented 3 years ago

https://github.com/Orange-OpenSource/casskop/edit/master/website/docs/1_concepts/2_features.md#L36

Last feature in Features page is backup & restore, other features to include ? (Cassandra, etc.)

DONE

PERES-Richard commented 3 years ago

https://github.com/Orange-OpenSource/casskop/edit/master/website/docs/1_concepts/4_roadmap.md#L6

RoadMap page empty, delete it ?

DONE

PERES-Richard commented 3 years ago

https://github.com/Orange-OpenSource/casskop/edit/master/website/docs/2_setup/1_getting_started.md#L9

Bump Cassandra version to 4.X ?

TODO ? @cscetbon

https://github.com/Orange-OpenSource/casskop/edit/master/website/docs/2_setup/1_getting_started.md#L17 Fast remote storage still not tested yet ?

TODO ? @cscetbon

https://github.com/Orange-OpenSource/casskop/edit/master/website/docs/2_setup/1_getting_started.md#L55 "Deploy CassKop using a ConfigMap" => Remove this or add a label "FOR V1 ONLY ?" ? Maybe add a splitter for v1 install vs v2 Also maybe mention the "options" for the v2 here as well ?

TODO ? @cscetbon

https://github.com/Orange-OpenSource/casskop/edit/master/website/docs/2_setup/1_getting_started.md#L92 Bump Grafana version to 8.1.3 ?

TO BE TESTED BEFORE

PERES-Richard commented 3 years ago

https://github.com/Orange-OpenSource/casskop/edit/update-doc/website/docs/2_setup/5_upgrade_v1_to_v2.md

Add a link / notes to Cassandra 3 to 4 migration (for data, tables, etc.) and how it's impact CassKop

TODO ? @cscetbon

PERES-Richard commented 3 years ago

https://github.com/Orange-OpenSource/casskop/edit/master/website/docs/3_configuration_deployment/1_customizable_install_with_helm.md#L121

Not sure that helm3 keeps track of deleted charts but I am sure that it's allow use of a deleted / uninstalled chart's name for another installation.

DONE