文档中心MogDBMogDB StackUqbar

文档:v2.0

支持的版本:

mgo 客户端

MogDB Operator Client,简称 mgo,是与 MogDB Operator 交互的最便捷方式。mgo 通过一系列简单的命令,为创建、管理和删除 MogDB 集群提供了许多便捷的方法。 MogDB Operator 提供了于 mgo 客户端连接的接口,并通过 RBAC 和 TLS 进行验证管理。

deploy-arch

mgo 客户端可用于 Linux、macOS,您可以从发布版本中选择您所需的 mgo 客户端,注意,mgo 客户端的版本必须与 MogDB Operator 的版本匹配。


使用 mgo 客户端的一般注意事项

如果您使用快速入门指南安装 MogDB Operator,您会将 MogDB Operator 安装到名为 mogdb-operator-system 命名空间下。

为方便起见,我们建议设置 mogdb-operator-system 为环境变量 MGO_NAMESPACE 的值。在您将执行 mgo 命令的 shell 中,运行以下命令:

export MGO_NAMESPACE=mogdb-operator-system

如果您不想设置此环境变量,或者处于无法使用环境变量的环境中,则必须对大多数命令使用 --namespace(or -n) 标志,例如:

mgo version -n mogdb-operator-system

语法

有关 mgo 客户端的命令的详细阐述,请参考命令行相关内容。

mgo 的语法类似于您使用 kubectl 一样简单,MogDB Operator 项目的目标之一是允许在支持 Kubernetes 的环境中无缝管理 MogDB 集群,并且通过遵循用户熟悉的命令模式,使学习曲线变得更加容易。

要了解 mgo 命令的顶层可用内容,请执行:

mgo

mgo 命令的语法通常遵循以下格式:

pgo [command] ([TYPE] [NAME]) [flags]

其中 command 是一个动词,例如:

  • create
  • show
  • delete

type 是一种资源类型,例如:

  • cluster
  • mgorole
  • mgouser

name 是资源类型的名称,例如:

  • cluster1
  • admin

有些全局 flag 作用于每个 mgo 命令,有些特殊 flag 作用于指定 mgo 命令,要获取命令可用的所有选项和 flag的列表,您可以使用 --help flag。例如,要查看 mgo create cluster 命令可用的所有选项,您可以运行以下命令:

mgo create cluster --help
Copyright © 2011-2024 www.enmotech.com All rights reserved.