github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/pkg/controller/rsm/doc.go (about)

     1  /*
     2  Copyright (C) 2022-2023 ApeCloud Co., Ltd
     3  
     4  This file is part of KubeBlocks project
     5  
     6  This program is free software: you can redistribute it and/or modify
     7  it under the terms of the GNU Affero General Public License as published by
     8  the Free Software Foundation, either version 3 of the License, or
     9  (at your option) any later version.
    10  
    11  This program is distributed in the hope that it will be useful
    12  but WITHOUT ANY WARRANTY; without even the implied warranty of
    13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    14  GNU Affero General Public License for more details.
    15  
    16  You should have received a copy of the GNU Affero General Public License
    17  along with this program.  If not, see <http://www.gnu.org/licenses/>.
    18  */
    19  
    20  /*
    21  Package rsm is a general component aims to hold role-based stateful workloads(such as databases).
    22  RSM stands for Replicated State Machine based on the truth that the workloads are solving state replication related problems.
    23  Treat RSM as an enhanced StatefulSet.
    24  
    25  The K8s native StatefulSet can handle stateful workloads well,
    26  but there are more works to do if the workload pods have roles(leader/follower in etcd, primary/secondary in PostgreSQL etc.).
    27  
    28  RSM adds an abstract layer above StatefulSet, and provides:
    29  1. role-based update strategy(Serial/Parallel/BestEffortParallel)
    30  2. role-based access modes(ReadWrite/Readonly/None)
    31  3. auto switchover
    32  4. membership reconfiguration
    33  */
    34  package rsm