cubefs/cli/cmd/const.go

// Copyright 2018 The CubeFS Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.

package cmd

const (
	// List of operation name for cli
	CliOpGet                         = "get"
	CliOpList                        = "list"
	CliOpStatus                      = "stat"
	CliOpCreate                      = "create"
	CliOpDelete                      = "delete"
	CliOpRemove                      = "remove"
	CliOpInfo                        = "info"
	CliOpAdd                         = "add"
	CliOpSet                         = "set"
	CliOpUpdate                      = "update"
	CliOpDecommission                = "decommission"
	CliOpRecommission                = "recommission"
	CliOpQueryProgress               = "query-progress"
	CliOpAbortDecommission           = "abort-decommission"
	CliOpMigrate                     = "migrate"
	CliOpDownloadZip                 = "load"
	CliOpMetaCompatibility           = "meta"
	CliOpFreeze                      = "freeze"
	CliOpSetThreshold                = "threshold"
	CliOpSetVolDeletionDelayTime     = "volDeletionDelayTime"
	CliOpSetCluster                  = "set"
	CliOpCheck                       = "check"
	CliOpReset                       = "reset"
	CliOpReplicate                   = "add-replica"
	CliOpDelReplica                  = "del-replica"
	CliOpExpand                      = "expand"
	CliOpShrink                      = "shrink"
	CliOpGetDiscard                  = "get-discard"
	CliOpSetDiscard                  = "set-discard"
	CliOpForbidMpDecommission        = "forbid-mp-decommission"
	CliOpQueryDecommissionedDisk     = "query-decommissioned-disk"
	CliOpEnableAutoDecommission      = "enable-auto-decommission"
	CliOpQueryDecommissionFailedDisk = "query-decommission-failed-disk"
	CliOpSetDecommissionDiskLimit    = "set-decommission-disk-limit"
	CliOpResetRestoreStatus          = "reset-restore-status"
	CliOpCancelDecommission          = "cancel-decommission"
	CliOpDiskOp                      = "diskop"
	CliOpDpOp                        = "dpop"
	CliOpDataNodeOp                  = "datanodeop"
	CliOpVolOp                       = "volop"
	CliOpToLeader                    = "to-leader"

	CliOpSetDecommissionLimit    = "set-decommission-limit"
	CliOpQueryDecommissionStatus = "query-decommission-status"

	// Shorthand format of operation name
	CliOpDecommissionShortHand = "dec"

	// resource name
	CliResourceDataNode      = "datanode [COMMAND]"
	CliResourceMetaNode      = "metanode"
	CliResourceDataPartition = "datapartition"
	CliResourceMetaPartition = "metapartition"
	CliResourceTopology      = "topology"
	CliResourceRaftNode      = "raftnode"
	CliResourceDisk          = "disk"
	CliResourceConfig        = "config"

	// Flags
	CliFlagName                         = "name"
	CliFlagOnwer                        = "user"
	CliFlagDataPartitionSize            = "dp-size"
	CliFlagDataPartitionCount           = "dp-count"
	CliFlagMetaPartitionCount           = "mp-count"
	CliFlagReplicas                     = "replicas"
	CliFlagEnable                       = "enable"
	CliFlagEnableFollowerRead           = "follower-read"
	CliFlagAuthenticate                 = "authenticate"
	CliFlagCapacity                     = "capacity"
	CliFlagBusiness                     = "description"
	CliFlagMPCount                      = "mp-count"
	CliFlagDPCount                      = "dp-count"
	CliFlagReplicaNum                   = "replica-num"
	CliFlagSize                         = "size"
	CliFlagVolType                      = "vol-type"
	CliFlagFollowerRead                 = "follower-read"
	CliFlagMetaFollowerRead             = "meta-follower-read"
	CliFlagMaximallyRead                = "maximally-read"
	CliFlagCacheRuleKey                 = "cache-rule-key"
	CliFlagEbsBlkSize                   = "ebs-blk-size"
	CliFlagCacheThreshold               = "cache-threshold"
	CliFlagCacheRule                    = "cache-rule"
	CliFlagThreshold                    = "threshold"
	CliFlagAddress                      = "addr"
	CliFlagDiskPath                     = "path"
	CliFlagAuthKey                      = "authkey"
	CliFlagINodeStartID                 = "inode-start"
	CliFlagId                           = "id"
	CliFlagZoneName                     = "zone-name"
	CliFlagFlashZoneName                = "zoneName"
	CliFlagDescription                  = "description"
	CliFlagAutoRepairRate               = "autoRepairRate"
	CliFlagDelBatchCount                = "batchCount"
	CliFlagDelWorkerSleepMs             = "deleteWorkerSleepMs"
	CliFlagLoadFactor                   = "loadFactor"
	CliFlagMarkDelRate                  = "markDeleteRate"
	CliFlagMaxDpCntLimit                = "maxDpCntLimit"
	CliFlagMaxMpCntLimit                = "maxMpCntLimit"
	CliFlagDataNodeSelector             = "dataNodeSelector"
	CliFlagMetaNodeSelector             = "metaNodeSelector"
	CliFlagDataNodesetSelector          = "dataNodesetSelector"
	CliFlagMetaNodesetSelector          = "metaNodesetSelector"
	CliFlagCrossZone                    = "crossZone"
	CliNormalZonesFirst                 = "normalZonesFirst"
	CliFlagCount                        = "count"
	CliDpReadOnlyWhenVolFull            = "readonly-when-full"
	CliTxMask                           = "transaction-mask"
	CliTxTimeout                        = "transaction-timeout"
	CliTxOpLimit                        = "transaction-limit"
	CliTxConflictRetryNum               = "tx-conflict-retry-num"
	CliTxConflictRetryInterval          = "tx-conflict-retry-Interval"
	CliTxForceReset                     = "transaction-force-reset"
	CliFlagMaxFiles                     = "maxFiles"
	CliFlagMaxBytes                     = "maxBytes"
	CliFlagMaxConcurrencyInode          = "maxConcurrencyInode"
	CliFlagForceInode                   = "forceInode"
	CliFlagEnableQuota                  = "enableQuota"
	CliFlagDeleteLockTime               = "delete-lock-time"
	CliFlagClientIDKey                  = "clientIDKey"
	CliFlagMarkDiskBrokenThreshold      = "markBrokenDiskThreshold"
	CliFlagForce                        = "force"
	CliFlagEnableCrossZone              = "cross-zone"
	CliFlagAutoDpMetaRepair             = "autoDpMetaRepair"
	CliFlagAutoDpMetaRepairParallelCnt  = "autoDpMetaRepairParallelCnt"
	CliFlagDpRepairTimeout              = "dpRepairTimeout"
	CliFlagDpTimeout                    = "dpHeartbeatTimeout"
	CliFlagMpTimeout                    = "mpHeartbeatTimeout"
	CliFlagAutoDecommissionDisk         = "autoDecommissionDisk"
	CliFlagAutoDecommissionDiskInterval = "autoDecommissionDiskInterval"
	CliFlagDpBackupTimeout              = "dpBackupTimeout"
	CliFlagDecommissionDpLimit          = "decommissionDpLimit"
	CliFlagDecommissionDiskLimit        = "decommissionDiskLimit"
	CliFlagTrashInterval                = "trashInterval"
	CliFlagAccessTimeValidInterval      = "accessTimeValidInterval"
	CliFlagEnablePersistAccessTime      = "enablePersistAccessTime"
	CliFlagDecommissionRaftForce        = "raftForceDel"
	CliFlagAllowedStorageClass          = "allowedStorageClass"
	CliFlagVolStorageClass              = "volStorageClass"
	CliFlagMediaType                    = "mediaType"
	CliForbidWriteOpOfProtoVersion0     = "forbidWriteOpOfProtoVersion0"
	CliFlagVolQuotaClass                = "quotaClass"
	CliFlagVolQuotaOfClass              = "quotaOfStorageClass"

	CliFlagRemoteCacheEnable            = "remoteCacheEnable"
	CliFlagRemoteCachePath              = "remoteCachePath"
	CliFlagRemoteCacheAutoPrepare       = "remoteCacheAutoPrepare"
	CliFlagRemoteCacheTTL               = "remoteCacheTTL"
	CliFlagRemoteCacheReadTimeout       = "remoteCacheReadTimeout"
	CliFlagRemoteCacheMaxFileSizeGB     = "remoteCacheMaxFileSizeGB"
	CliFlagRemoteCacheOnlyForNotSSD     = "remoteCacheOnlyForNotSSD"
	CliFlagRemoteCacheMultiRead         = "remoteCacheMultiRead"
	CliFlagFlashNodeTimeoutCount        = "flashNodeTimeoutCount"
	CliFlagRemoteCacheSameZoneTimeout   = "remoteCacheSameZoneTimeout"
	CliFlagRemoteCacheSameRegionTimeout = "remoteCacheSameRegionTimeout"

	// CliFlagSetDataPartitionCount	= "count" use dp-count instead

	// Shorthand format of resource name
	ResourceDataNodeShortHand      = "dn"
	ResourceMetaNodeShortHand      = "mn"
	ResourceDataPartitionShortHand = "dp"
	ResourceMetaPartitionShortHand = "mp"

	// Usages
	CliUsageClientIDKey = "needed if cluster authentication is on"
	// version op
	CliFlagVersionCreate      = "verCreate"
	CliFlagVersionList        = "verList"
	CliFlagVersionDel         = "verDel"
	CliFlagVersionSetStrategy = "verSetStrategy"
)

type MasterOp int

const (
	OpExpandVol MasterOp = iota
	OpShrinkVol
	OpCreateVol
	OpDeleteVol
)