github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/pkg/cli/cmd/playground/types.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 playground
    21  
    22  import (
    23  	"github.com/pkg/errors"
    24  
    25  	"github.com/1aal/kubeblocks/pkg/cli/cloudprovider"
    26  	"github.com/1aal/kubeblocks/pkg/cli/util"
    27  )
    28  
    29  const (
    30  	yesStr = "yes"
    31  )
    32  
    33  const (
    34  	defaultCloudProvider = cloudprovider.Local
    35  	defaultClusterDef    = "apecloud-mysql"
    36  
    37  	// defaultNamespace is the namespace of playground cluster
    38  	defaultNamespace = "default"
    39  
    40  	// stateFileName is the file name of playground state file
    41  	stateFileName = "kb-playground.state"
    42  
    43  	// CloudClusterNamePrefix the prefix of cloud kubernetes cluster name
    44  	cloudClusterNamePrefix = "kb-playground"
    45  )
    46  
    47  var (
    48  	// kbClusterName is the playground cluster name that created by KubeBlocks
    49  	kbClusterName = "mycluster"
    50  
    51  	// defaultKubeConfigPath is the default kubeconfig path, it is ~/.kube/config
    52  	defaultKubeConfigPath = util.ConfigPath("config")
    53  )
    54  
    55  // errors
    56  var (
    57  	kubeClusterUnreachableErr = errors.New("Kubernetes cluster unreachable")
    58  )
    59  
    60  var guideStr = `
    61  1. Basic commands for cluster:
    62  
    63    kbcli cluster list                     # list database cluster and check its status
    64    kbcli cluster describe %[1]s       # get cluster information
    65  
    66  2. Connect to database
    67  
    68    kbcli cluster connect %[1]s
    69    
    70  3. View the Grafana:
    71  
    72    kbcli dashboard open kubeblocks-grafana
    73  	
    74  4. Destroy Playground:
    75  
    76    kbcli playground destroy
    77  
    78  --------------------------------------------------------------------
    79  To get more help: kbcli help
    80  Use "kbcli [command] --help" for more information about a command.
    81  `