From a73ba3d0130a143abf59d295ed406f1cf15bf1f2 Mon Sep 17 00:00:00 2001 From: Xudong Sun Date: Thu, 6 Jun 2024 11:05:50 -0500 Subject: [PATCH] Add docs on Kubernetes core components to `discussion` (#494) Signed-off-by: Xudong Sun --- .../kubernetes-model}/finalizers.md | 0 .../kubernetes-model}/garbage_collector.md | 0 .../kubernetes-model}/stateful_set_controller.md | 0 .../kubernetes-model}/validation.md | 0 doc/controllers_to_port.md | 15 --------------- doc/{framework_design.md => kubernetes_model.md} | 4 ++-- doc/verified_controllers.md | 3 +++ 7 files changed, 5 insertions(+), 17 deletions(-) rename {doc => discussion/kubernetes-model}/finalizers.md (100%) rename {doc => discussion/kubernetes-model}/garbage_collector.md (100%) rename {doc => discussion/kubernetes-model}/stateful_set_controller.md (100%) rename {doc => discussion/kubernetes-model}/validation.md (100%) delete mode 100644 doc/controllers_to_port.md rename doc/{framework_design.md => kubernetes_model.md} (96%) create mode 100644 doc/verified_controllers.md diff --git a/doc/finalizers.md b/discussion/kubernetes-model/finalizers.md similarity index 100% rename from doc/finalizers.md rename to discussion/kubernetes-model/finalizers.md diff --git a/doc/garbage_collector.md b/discussion/kubernetes-model/garbage_collector.md similarity index 100% rename from doc/garbage_collector.md rename to discussion/kubernetes-model/garbage_collector.md diff --git a/doc/stateful_set_controller.md b/discussion/kubernetes-model/stateful_set_controller.md similarity index 100% rename from doc/stateful_set_controller.md rename to discussion/kubernetes-model/stateful_set_controller.md diff --git a/doc/validation.md b/discussion/kubernetes-model/validation.md similarity index 100% rename from doc/validation.md rename to discussion/kubernetes-model/validation.md diff --git a/doc/controllers_to_port.md b/doc/controllers_to_port.md deleted file mode 100644 index 54b870c0c..000000000 --- a/doc/controllers_to_port.md +++ /dev/null @@ -1,15 +0,0 @@ -## Controllers to port - -This is a loose list of controllers we'd like to port to Anvil someday. -The initial list is populated using the tested operators from the Sieve project. - -* [cass-operator](https://github.com/k8ssandra/cass-operator) -* [cassandra-operator](https://github.com/instaclustr/cassandra-operator) -* [casskop](https://github.com/cscetbon/casskop) -* [elastic-operator](https://github.com/elastic/cloud-on-k8s) -* [mongodb-operator](https://github.com/percona/percona-server-mongodb-operator) -* [nifikop](https://github.com/konpyutaika/nifikop) -* [rabbitmq-operator](https://github.com/rabbitmq/cluster-operator) -* [xtradb-operator](https://github.com/percona/percona-xtradb-cluster-operator) -* [yugabyte-operator](https://github.com/yugabyte/yugabyte-operator) -* [zookeeper-operator](https://github.com/pravega/zookeeper-operator) \ No newline at end of file diff --git a/doc/framework_design.md b/doc/kubernetes_model.md similarity index 96% rename from doc/framework_design.md rename to doc/kubernetes_model.md index 68ba9d556..17fd157f0 100644 --- a/doc/framework_design.md +++ b/doc/kubernetes_model.md @@ -1,6 +1,6 @@ -We give an overview of the clock-based approach we use to model a distributed system. +## Kubernetes Model -## Environmental Assumptions +**The description below is outdated and needs heavy revision.** We plan to start from simple controllers and environmental specifications. diff --git a/doc/verified_controllers.md b/doc/verified_controllers.md new file mode 100644 index 000000000..026f4d3b0 --- /dev/null +++ b/doc/verified_controllers.md @@ -0,0 +1,3 @@ +## Verified Controllers + +Todo \ No newline at end of file