types

package

v1.0.0-RC Latest Latest Go to latest Published: May 21, 2021 License: AGPL-3.0 Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/erda-project/erda

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	DefaultWorkspace apistructs.DiceWorkspace = "DEFAULT"
	// DevWorkspace 开发环境
	DevWorkspace apistructs.DiceWorkspace = "DEV"
	// TestWorkspace 测试环境
	TestWorkspace apistructs.DiceWorkspace = "TEST"
	// StagingWorkspace 预发环境
	StagingWorkspace apistructs.DiceWorkspace = "STAGING"
	// ProdWorkspace 生产环境
	ProdWorkspace apistructs.DiceWorkspace = "PROD"
)

View Source

const (
	// sys
	RoleSysManager = "Manager"

	// org
	RoleOrgManager         = "Manager"
	RoleOrgDev             = "Dev"
	RoleOrgOps             = "Ops"
	RoleOrgSupport         = "Support"
	RoleOrgDataManager     = "DataManager"
	RoleOrgDataEngineer    = "DataEngineer"
	RoleOrgReporter        = "Reporter"
	RoleOrgEdgeAppEngineer = "EdgeOps"
	RoleOrgGuest           = "Guest"

	// project
	RoleProjectOwner    = "Owner"
	RoleProjectLead     = "Lead"
	RoleProjectPM       = "PM"
	RoleProjectPD       = "PD"
	RoleProjectDev      = "Dev"
	RoleProjectQA       = "QA"
	RoleProjectReporter = "Reporter"
	RoleProjectGuest    = "Guest"

	// app
	RoleAppOwner = "Owner"
	RoleAppLead  = "Lead"
	RoleAppDev   = "Dev"
	RoleAppQA    = "QA"
	RoleAppOps   = "Ops"
	RoleAppGuest = "Guest"

	// publisher
	RolePublisherManager = "PublisherManager"
	RolePublisherMember  = "PublisherMember"

	// guest
	RoleGuest = "Guest"
)

View Source

const (
	UnknownType = "unknown"
)

Variables ¶

View Source

var AllLabelsMap = map[apistructs.MemeberLabelName]MemberLabelInfo{
	apistructs.LabelNameOutsource: {Label: apistructs.LabelNameOutsource, I18nKey: "MemberLabelOutsource"},
	apistructs.LabelNamePartner:   {Label: apistructs.LabelNamePartner, I18nKey: "MemberLabelPartner"},
}

AllLabelsMap 记录所有的成员标签

View Source

var AllScopeRoleMap = map[apistructs.ScopeType]map[string]RoleInfo{
	apistructs.SysScope: {
		RoleSysManager: {Role: RoleSysManager, IsHide: false, I18nKey: "SysManagerRole", IsManager: true, Level: 0},
	},
	apistructs.OrgScope: {
		RoleOrgManager:         {Role: RoleSysManager, IsHide: false, I18nKey: "OrgManagerRole", IsManager: true, Level: 0},
		RoleOrgDev:             {Role: RoleOrgDev, IsHide: false, I18nKey: "OrgDevRole", IsManager: false, Level: 1},
		RoleOrgOps:             {Role: RoleOrgOps, IsHide: false, I18nKey: "OrgOpsRole", IsManager: false, Level: 2},
		RoleOrgDataManager:     {Role: RoleOrgDataManager, IsHide: false, I18nKey: "OrgDataManagerRole", IsManager: false, Level: 3},
		RoleOrgDataEngineer:    {Role: RoleOrgDataEngineer, IsHide: false, I18nKey: "OrgDataEngineerRole", IsManager: false, Level: 4},
		RoleOrgSupport:         {Role: RoleOrgSupport, IsHide: true, I18nKey: "OrgSupportRole", IsManager: false, Level: 5},
		RoleOrgReporter:        {Role: RoleOrgReporter, IsHide: false, I18nKey: "OrgReporterRole", IsManager: false, Level: 6},
		RolePublisherManager:   {Role: RolePublisherManager, IsHide: false, I18nKey: "PublisherManagerRole", IsManager: false, Level: 7},
		RoleOrgEdgeAppEngineer: {Role: RoleOrgEdgeAppEngineer, IsHide: false, I18nKey: "RoleOrgEdgeAppEngineer", IsManager: false, Level: 8},
		RoleOrgGuest:           {Role: RoleProjectGuest, IsHide: true, I18nKey: "OrgGuestRole", IsManager: false, Level: 9},
	},
	apistructs.ProjectScope: {
		RoleProjectOwner:    {Role: RoleProjectOwner, IsHide: false, I18nKey: "ProjectOwnerRole", IsManager: true, Level: 0},
		RoleProjectLead:     {Role: RoleProjectLead, IsHide: false, I18nKey: "ProjectLeadRole", IsManager: true, Level: 1},
		RoleProjectPM:       {Role: RoleProjectPM, IsHide: false, I18nKey: "ProjectPMRole", IsManager: true, Level: 2},
		RoleProjectPD:       {Role: RoleProjectPD, IsHide: false, I18nKey: "ProjectPDRole", IsManager: false, Level: 3},
		RoleProjectDev:      {Role: RoleProjectDev, IsHide: false, I18nKey: "ProjectDevRole", IsManager: false, Level: 4},
		RoleProjectQA:       {Role: RoleProjectQA, IsHide: false, I18nKey: "ProjectQARole", IsManager: false, Level: 5},
		RoleProjectReporter: {Role: RoleProjectReporter, IsHide: false, I18nKey: "ProjectReporterRole", IsManager: false, Level: 6},
		RoleProjectGuest:    {Role: RoleProjectGuest, IsHide: true, I18nKey: "ProjectGuestRole", IsManager: false, Level: 7},
	},
	apistructs.AppScope: {
		RoleAppOwner: {Role: RoleAppOwner, IsHide: false, I18nKey: "AppOwnerRole", IsManager: true, Level: 0},
		RoleAppLead:  {Role: RoleAppLead, IsHide: false, I18nKey: "AppLeadRole", IsManager: true, Level: 1},
		RoleAppOps:   {Role: RoleAppOps, IsHide: false, I18nKey: "AppOpsRole", IsManager: false, Level: 2},
		RoleAppDev:   {Role: RoleAppDev, IsHide: false, I18nKey: "AppDevRole", IsManager: false, Level: 3},
		RoleAppQA:    {Role: RoleAppQA, IsHide: false, I18nKey: "AppQARole", IsManager: false, Level: 4},
		RoleAppGuest: {Role: RoleAppGuest, IsHide: true, I18nKey: "AppGuestRole", IsManager: false, Level: 5},
	},
	apistructs.PublisherScope: {
		RolePublisherManager: {Role: RolePublisherManager, IsHide: false, I18nKey: "PublisherManagerRole", IsManager: true, Level: 0},
		RolePublisherMember:  {Role: RolePublisherMember, IsHide: false, I18nKey: "PublisherMemberRole", IsManager: false, Level: 1},
	},
}

AllScopeRoleMap 记录所有 scope 下所有角色信息

View Source

var ContainerStatusIndex = map[InstanceStatus]int{
	InstanceStatusStarting:  1,
	InstanceStatusRunning:   1,
	InstanceStatusHealthy:   2,
	InstanceStatusUnHealthy: 2,
	InstanceStatusUnknown:   2,
	InstanceStatusStopped:   3,
	InstanceStatusFailed:    3,
	InstanceStatusFinished:  3,
	InstanceStatusKilled:    4,
	InstanceStatusOOM:       5,
}

View Source

var NotFound = "not found"

NotFound error define for notfound

Functions ¶

func CheckIfMemberLabelIsValid ¶

func CheckIfMemberLabelIsValid(label string) bool

CheckIfMemberLabelIsValid 判断 label 是否合法

func CheckIfRoleIsManager ¶

func CheckIfRoleIsManager(role string) bool

CheckIfRoleIsManager 判断 role 是否是管理员角色

func CheckIfRoleIsOwner ¶

func CheckIfRoleIsOwner(role string) bool

CheckIfRoleIsOwner 判断 role 是否是项目/应用所有者角色

func CheckIfRoleIsValid ¶

func CheckIfRoleIsValid(role string) bool

CheckIfRoleIsValid 判断 role 是否合法

func GetScopeManagerRoleMap ¶

func GetScopeManagerRoleMap() map[apistructs.ScopeType]map[string]RoleInfo

GetScopeManagerRoleMap 获取所有 scopeType 下的管理员角色信息 map

func GetScopeManagerRoleNames ¶

func GetScopeManagerRoleNames(scopeType apistructs.ScopeType) []string

GetScopeManagerRoleNames 获取 scopeType 下的管理员角色名

func IsValidAgentInstanceStatus ¶

func IsValidAgentInstanceStatus(status string) bool

func IsValidSchedulerInstanceStatus ¶

func IsValidSchedulerInstanceStatus(status string) bool

Types ¶

type AbilityAppReq ¶

type AbilityAppReq struct {
	OrgID           int64 `json:"orgId"`
	ClusterID       int64 `json:"clusterId"`
	ClusterName     string
	ApplicationName string
	UserID          string `json:"operator"`
}

AbilityAppReq 能力请求

type CmContainer ¶

type CmContainer struct {
	ModelHeader         `json:"-"`
	ID                  string  `json:"id" gorm:"column:container_id;index:container_id"` // 容器ID
	Deleted             bool    `json:"deleted"`                                          // 资源是否被删除
	StartedAt           string  `json:"started_at"`                                       // 容器启动时间
	FinishedAt          string  `json:"finished_at"`                                      // 容器结束时间
	ExitCode            int     `json:"exit_code"`                                        // 容器退出码
	Privileged          bool    `json:"privileged"`                                       // 是否是特权容器
	Cluster             string  `json:"cluster_full_name"`                                // 集群名
	HostPrivateIPAddr   string  `json:"host_private_addr"`                                // 宿主机内网地址
	IPAddress           string  `json:"ip_addr"`                                          // 容器IP地址
	Image               string  `json:"image_name"`                                       // 容器镜像名
	CPU                 float64 `json:"cpu"`                                              // 分配的cpu
	Memory              int64   `json:"memory"`                                           // 分配的内存（字节）
	Disk                int64   `json:"disk"`                                             // 分配的磁盘空间（字节）
	DiceOrg             string  `json:"dice_org"`                                         // 所在的组织
	DiceProject         string  `json:"dice_project"`                                     // 所在大项目
	DiceApplication     string  `json:"dice_application"`                                 // 所在项目
	DiceRuntime         string  `json:"dice_runtime"`                                     // 所在runtime
	DiceService         string  `json:"dice_service"`                                     // 所属应用
	DiceProjectName     string  `json:"dice_project_name"`                                // 所在大项目名称
	DiceApplicationName string  `json:"dice_application_name"`                            // 所在项目
	DiceRuntimeName     string  `json:"dice_runtime_name"`                                // 所在runtime
	DiceComponent       string  `json:"dice_component"`                                   // 组件名
	DiceAddon           string  `json:"dice_addon"`                                       // 中间件id
	DiceAddonName       string  `json:"dice_addon_name"`                                  // 中间件名称
	DiceWorkspace       string  `json:"dice_workspace"`                                   // 部署环境
	DiceSharedLevel     string  `json:"dice_shared_level"`                                // 中间件共享级别
	Status              string  `json:"status"`                                           // 前期定义为docker状态（后期期望能表示服务状态）
	TimeStamp           int64   `json:"timestamp"`                                        // 消息本身的时间戳
	TaskID              string  `json:"task_id" gorm:"column:task_id;index:task_id"`      // task id
	Env                 string  `json:"env,omitempty" gorm:"-"`                           // 该容器由哪个环境发布(dev, test, staging, prod)
}

CmContainer 容器元数据

type CmHost ¶

type CmHost struct {
	ModelHeader   `json:"-"`
	Name          string  `json:"hostname"`                               // 主机名
	Cluster       string  `json:"cluster_full_name" gorm:"index:cluster"` // 集群名字
	Cpus          float64 `json:"cpus"`                                   // 总CPU个数
	Memory        int64   `json:"memory"`                                 // 总内存数（字节）
	Disk          int64   `json:"disk"`                                   // 磁盘大小（字节）
	PrivateAddr   string  `json:"private_addr"`                           // 内网地址
	Labels        string  `json:"labels"`                                 // 环境标签
	OS            string  `json:"os"`                                     // 操作系统类型
	KernelVersion string  `json:"kernel_version"`                         // 内核版本
	SystemTime    string  `json:"system_time"`                            // 系统时间
	Birthday      int64   `json:"created_at"`                             // 创建时间（operator定义）
	Deleted       bool    `json:"deleted"`                                // 资源是否被删除
	TimeStamp     int64   `json:"timestamp"`                              // 消息本身的时间戳
}

CmHost 主机元数据

type CmService ¶

type CmService struct {
	ModelHeader     `json:"-"`
	Cluster         string `json:"-"`            // 集群名
	DiceProject     string `json:"-"`            // 所在大项目名称
	DiceApplication string `json:"-"`            // 所在项目
	DiceRuntime     string `json:"-"`            // 所在runtime
	DiceService     string `json:"-"`            // 所属应用
	PrivateAddr     string `json:"private_addr"` // 服务内部地址(lb)
	PublicAddr      string `json:"public_addr"`  // 服务对外地址(lb)
}

CmService 服务

type InstanceStatus ¶

type InstanceStatus string

InstanceStatus instance status

const (
	InstanceStatusStarting  InstanceStatus = "Starting" // 已启动，但未收到健康检查事件，瞬态
	InstanceStatusRunning   InstanceStatus = "Running"
	InstanceStatusHealthy   InstanceStatus = "Healthy"
	InstanceStatusUnHealthy InstanceStatus = "UnHealthy" // 已启动但收到未通过健康检查事件
	InstanceStatusFinished  InstanceStatus = "Finished"  // 已完成，退出码为0
	InstanceStatusFailed    InstanceStatus = "Failed"    // 已退出，退出码非0
	InstanceStatusKilled    InstanceStatus = "Killed"    // 已被杀
	InstanceStatusStopped   InstanceStatus = "Stopped"   // 已停止，Scheduler与DCOS断连期间事件丢失，后续补偿时，需将Healthy置为Stopped
	InstanceStatusUnknown   InstanceStatus = "Unknown"
	InstanceStatusOOM       InstanceStatus = "OOM"
	InstanceStatusDead      InstanceStatus = "Dead"
)

type MemberLabelInfo ¶

type MemberLabelInfo struct {
	Label   apistructs.MemeberLabelName `json:"label"`
	I18nKey string                      `json:"i18nKey"`
}

MemberLabelInfo 成员标签信息

type MetaserverMSG ¶

type MetaserverMSG struct {
	Name      string                 `json:"name"`      // metaserver_container、metaserver_all_containers
	TimeStamp int64                  `json:"timestamp"` // 纳秒
	Fields    map[string]interface{} `json:"fields"`    // 全量容器事件时 key: containerID value: container info
	Tags      map[string]string      `json:"tags,omitempty"`
}

MetaserverMSG kafka容器信息格式

type ModelHeader ¶

type ModelHeader struct {
	ID        int64 `gorm:"primary_key"`
	CreatedAt time.Time
	UpdatedAt time.Time
}

ModelHeader metadata header

type RoleInfo ¶

type RoleInfo struct {
	Role      string `json:"role"`
	IsHide    bool   `json:"isHide"`
	I18nKey   string `json:"i18nKey"`
	IsManager bool   `json:"isManager"`
	// 用来排序的字段
	Level int `json:"-"`
}

RoleInfo 角色信息

Source Files ¶

View all Source files

types.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func CheckIfMemberLabelIsValid ¶

func CheckIfRoleIsManager ¶

func CheckIfRoleIsOwner ¶

func CheckIfRoleIsValid ¶

func GetScopeManagerRoleMap ¶

func GetScopeManagerRoleNames ¶

func IsValidAgentInstanceStatus ¶

func IsValidSchedulerInstanceStatus ¶

Types ¶

type AbilityAppReq ¶

type CmContainer ¶

type CmHost ¶

type CmService ¶

type InstanceStatus ¶

type MemberLabelInfo ¶

type MetaserverMSG ¶

type ModelHeader ¶

type RoleInfo ¶

Source Files ¶