github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/pkg/lorry/client/interface.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  package client
    21  
    22  import "context"
    23  
    24  type Client interface {
    25  	// GetRole return the replication role(like primary/secondary) of the target replica
    26  	GetRole(ctx context.Context) (string, error)
    27  
    28  	// user management funcs
    29  	CreateUser(ctx context.Context, userName, password string) error
    30  	DeleteUser(ctx context.Context, userName string) error
    31  	DescribeUser(ctx context.Context, userName string) (map[string]any, error)
    32  	GrantUserRole(ctx context.Context, userName, roleName string) error
    33  	RevokeUserRole(ctx context.Context, userName, roleName string) error
    34  	ListUsers(ctx context.Context) ([]map[string]any, error)
    35  	ListSystemAccounts(ctx context.Context) ([]map[string]any, error)
    36  
    37  	// JoinMember sends a join member operation request to Lorry, located on the target pod that is about to join.
    38  	JoinMember(ctx context.Context) error
    39  
    40  	// LeaveMember sends a Leave member operation request to Lorry, located on the target pod that is about to leave.
    41  	LeaveMember(ctx context.Context) error
    42  }