conf

package
v1.0.0-rc Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 24, 2021 License: AGPL-3.0 Imports: 12 Imported by: 0

Documentation

Overview

Package conf 定义配置选项

Index

Constants

This section is empty.

Variables

View Source
var (

	// 域名白名单
	OrgWhiteList map[string]bool
	// legacy redirect paths
	RedirectPathList map[string]bool
)

Functions

func AddonAddr

func AddonAddr() string

AddonAddr 返回 AddonAddr 选项.

func AuditArchiveCron

func AuditArchiveCron() string

AuditArchiveCron 返回审计事件归档周期

func AuditCleanCron

func AuditCleanCron() string

AuditCleanCron 返回审计事件软删除周期

func AuditTemplate

func AuditTemplate() apistructs.AuditTemplateMap

AuditTemplate 返回权限列表

func AvatarStorageURL

func AvatarStorageURL() string

AvatarStorageURL 返回 OSSUsage 选项

func Base64EncodedRsaPrivateKey

func Base64EncodedRsaPrivateKey() string

Base64EncodedRsaPrivateKey 返回 rsa 私钥

func Base64EncodedRsaPublicKey

func Base64EncodedRsaPublicKey() string

Base64EncodedRsaPublicKey 返回 rsa 公钥

func CentralNexusAddr

func CentralNexusAddr() string

CentralNexusAddr 返回 中心集群 nexus 地址

func CentralNexusComponentName

func CentralNexusComponentName() string

CentralNexusComponentName 返回 中心集群 nexus 组件名

func CentralNexusPassword

func CentralNexusPassword() string

CentralNexusPassword 返回 中心集群 nexus 密码

func CentralNexusPublicURL

func CentralNexusPublicURL() string

CentralNexusPublicURL 返回 中心集群 nexus 公网地址

func CentralNexusUsername

func CentralNexusUsername() string

CentralNexusUsername 返回 中心集群 nexus 用户名

func Debug

func Debug() bool

Debug 返回 Debug 选项.

func DiceClusterName

func DiceClusterName() string

DiceClusterName 返回 cmdb 组件运行的中心集群名

func DicehubAddr

func DicehubAddr() string

DicehubAddr 返回 DicehubAddr 选项.

func DisableFileDownloadPermissionValidate added in v1.0.0

func DisableFileDownloadPermissionValidate() bool

DisableFileDownloadPermissionValidate return switch for file download permission check.

func EnableNS

func EnableNS() bool

EnableNS 是否打开项目级命名空间

func EventBoxAddr

func EventBoxAddr() string

EventBoxAddr 返回 EventBoxAddr 选项.

func FileMaxUploadSize

func FileMaxUploadSize() datasize.ByteSize

FileMaxUploadSize 返回 文件上传的大小限制.

func GittarAddr

func GittarAddr() string

GittarAddr 返回 GittarAddr 选项

func GittarOutterURL

func GittarOutterURL() string

GittarOutterURL 返回 GittarOutterURL 选项.

func HepaAddr

func HepaAddr() string

HepaAddr 返回 HepaAddr 选项.

func HostSyncInterval

func HostSyncInterval() time.Duration

HostSyncInterval 返回 HostSyncInterval 选项

func KafkaBrokers

func KafkaBrokers() string

KafkaBrokers 返回 KafkaBrokers 选项.

func KafkaContainerTopic

func KafkaContainerTopic() string

KafkaContainerTopic 返回 KafkaContainerTopic 选项.

func KafkaGroup

func KafkaGroup() string

KafkaGroup 返回 KafkaGroup 选项.

func KafkaHostTopic

func KafkaHostTopic() string

KafkaHostTopic 返回 KafkaHostTopic 选项.

func LicenseKey

func LicenseKey() string

LicenseKey 返回 LicenseKey 选项.

func ListenAddr

func ListenAddr() string

ListenAddr 返回 ListenAddr 选项.

func Load

func Load()

Load 加载配置项.

func LocalMode

func LocalMode() bool

LocalMode 本地调试模式

func MySQLDatabase

func MySQLDatabase() string

MySQLDatabase 返回 MySQLDatabase 选项.

func MySQLHost

func MySQLHost() string

MySQLHost 返回 MySQLHost 选项.

func MySQLLoc

func MySQLLoc() string

MySQLLoc 返回 MySQLLoc 选项.

func MySQLPassword

func MySQLPassword() string

MySQLPassword 返回 MySQLPassword 选项.

func MySQLPort

func MySQLPort() string

MySQLPort 返回 MySQLPort 选项.

func MySQLUsername

func MySQLUsername() string

MySQLUsername 返回 MySQLUsername 选项.

func OSSAccessID

func OSSAccessID() string

OSSAccessID 返回 oss access id.

func OSSAccessSecret

func OSSAccessSecret() string

OSSAccessSecret 返回 oss access secret

func OSSBucket

func OSSBucket() string

OSSBucket 返回 oss bucket.

func OSSEndpoint

func OSSEndpoint() string

OSSEndpoint 返回 oss endpoint.

func OSSPathPrefix

func OSSPathPrefix() string

OSSPathPrefix 返回 文件在指定 bucket 下的路径前缀.

func OpenAPIDomain

func OpenAPIDomain() string

OpenAPIDomain 返回 OpenAPIDomain 选项

func OryCompatibleClientID

func OryCompatibleClientID() string

func OryCompatibleClientSecret

func OryCompatibleClientSecret() string

func OryEnabled

func OryEnabled() bool

func OryKratosAddr

func OryKratosAddr() string

func OryKratosPrivateAddr

func OryKratosPrivateAddr() string

func Permissions

func Permissions() map[string]model.RolePermission

Permissions 获取权限配置

func ProjectStatsCacheCron

func ProjectStatsCacheCron() string

ProjectStatsCacheCron 项目状态缓存刷新周期

func QAAddr

func QAAddr() string

func RedisAddr

func RedisAddr() string

RedisAddr 返回 redis 地址

func RedisMasterName

func RedisMasterName() string

RedisMasterName 返回redis master name

func RedisPwd

func RedisPwd() string

RedisPwd 返回 redis 密码

func RedisSentinelAddrs

func RedisSentinelAddrs() string

RedisSentinelAddrs 返回 redis 哨兵地址

func RolePermissions

func RolePermissions(roles []string) (map[string]model.RolePermission, []model.RolePermission)

RolePermissions 获取角色对应的权限配置

func RootDomain

func RootDomain() string

RootDomain 返回 RootDomain 选项

func RootDomainList

func RootDomainList() []string

Multiple domain

func StorageMountPointInContainer

func StorageMountPointInContainer() string

StorageMountPointInContainer 返回 files 在容器内的挂载点.

func SysAuditCleanIterval

func SysAuditCleanIterval() int

SysAuditCleanIterval 返回 sys scope 审计事件软删除周期

func TaskCleanDuration

func TaskCleanDuration() time.Duration

TaskCleanDuration 返回 TaskCleanDuration 时间间隔

func TaskSyncDuration

func TaskSyncDuration() time.Duration

TaskSyncDuration 返回 TaskSyncDuration 时间间隔

func UCAddr

func UCAddr() string

UCAddr 返回 UCAddr 选项.

func UCClientID

func UCClientID() string

UCClientID 返回 UCClientID 选项.

func UCClientSecret

func UCClientSecret() string

UCClientSecret 返回 UCClientSecret 选项.

func UIDomain

func UIDomain() string

UIDomain 返回 UIDomain 选项

func UIPublicURL

func UIPublicURL() string

UIPublicURL 返回 UIPublicURL 选项

Types

type Conf

type Conf struct {
	LocalMode             bool          `env:"LOCAL_MODE" default:"false"`
	Debug                 bool          `env:"DEBUG" default:"false"`
	ListenAddr            string        `env:"LISTEN_ADDR" default:":9093"`
	KafkaBrokers          string        `env:"BOOTSTRAP_SERVERS"`
	KafkaContainerTopic   string        `env:"CMDB_CONTAINER_TOPIC"`
	KafkaHostTopic        string        `env:"CMDB_HOST_TOPIC"`
	KafkaGroup            string        `env:"CMDB_GROUP"`
	MySQLHost             string        `env:"MYSQL_HOST"`
	MySQLPort             string        `env:"MYSQL_PORT"`
	MySQLUsername         string        `env:"MYSQL_USERNAME"`
	MySQLPassword         string        `env:"MYSQL_PASSWORD"`
	MySQLDatabase         string        `env:"MYSQL_DATABASE"`
	MySQLLoc              string        `env:"MYSQL_LOC" default:"Local"`
	DicehubAddr           string        `env:"DICEHUB_ADDR"`
	QAAddr                string        `env:"QA_ADDR"`
	AddonAddr             string        `env:"ADDON_PLATFORM_ADDR"`
	GittarAddr            string        `env:"GITTAR_ADDR"`
	GittarOutterURL       string        `env:"GITTAR_PUBLIC_URL"`
	UCAddr                string        `env:"UC_ADDR"`
	UCClientID            string        `env:"UC_CLIENT_ID"`
	UCClientSecret        string        `env:"UC_CLIENT_SECRET"`
	EventBoxAddr          string        `env:"EVENTBOX_ADDR"`
	HepaAddr              string        `env:"HEPA_ADDR"`
	RootDomain            string        `env:"DICE_ROOT_DOMAIN"`
	UIPublicURL           string        `env:"UI_PUBLIC_URL"`
	UIDomain              string        `env:"UI_PUBLIC_ADDR"`
	OpenAPIDomain         string        `env:"OPENAPI_PUBLIC_ADDR"` // Deprecated: after cli refactored
	AvatarStorageURL      string        `env:"AVATAR_STORAGE_URL"`  // file:///avatars or oss://appkey:appsecret@endpoint/bucket
	LicenseKey            string        `env:"LICENSE_KEY"`
	HostSyncInterval      time.Duration `env:"INTERVAL" default:"2m"`                    // 主机实际资源使用同步间隔
	TaskSyncDuration      time.Duration `env:"TASK_SYNC_DURATION" default:"2h"`          // 任务状态信息同步间隔
	TaskCleanDuration     time.Duration `env:"TASK_CLEAN_DURATION" default:"24h"`        // 任务信息回收间隔
	AuditCleanCron        string        `env:"AUDIT_CLEAN_CRON" default:"0 0 3 * * ?"`   // 审计软删除任务执行周期
	AuditArchiveCron      string        `env:"AUDIT_ARCHIVE_CRON" default:"0 0 4 * * ?"` // 审计归档任务执行周期
	SysAuditCleanIterval  int           `env:"SYS_AUDIT_CLEAN_ITERVAL" default:"-7"`     // 系统审计清除周期
	RedisMasterName       string        `default:"my-master" env:"REDIS_MASTER_NAME"`
	RedisSentinelAddrs    string        `default:"" env:"REDIS_SENTINELS_ADDR"`
	RedisAddr             string        `default:"127.0.0.1:6379" env:"REDIS_ADDR"`
	RedisPwd              string        `default:"anywhere" env:"REDIS_PASSWORD"`
	ProjectStatsCacheCron string        `env:"PROJECT_STATS_CACHE_CRON" default:"0 0 1 * * ?"`
	EnableProjectNS       bool          `env:"ENABLE_PROJECT_NS" default:"true"`

	// --- 文件管理 begin ---
	FileMaxUploadSizeStr string `env:"FILE_MAX_UPLOAD_SIZE" default:"300MB"` // 文件上传限制大小,默认 300MB
	FileMaxUploadSize    datasize.ByteSize

	// disable file download permission validate temporarily for multi-domain
	DisableFileDownloadPermissionValidate bool `env:"DISABLE_FILE_DOWNLOAD_PERMISSION_VALIDATE" default:"false"`

	// fs
	// 修改该值的话,注意同步修改 dice.yml 中 '<%$.Storage.MountPoint%>/dice/cmdb/files:/files:rw' 容器内挂载点的值
	StorageMountPointInContainer string `env:"STORAGE_MOUNT_POINT_IN_CONTAINER" default:"/files"`

	// oss
	OSSEndpoint     string `env:"OSS_ENDPOINT"`
	OSSAccessID     string `env:"OSS_ACCESS_ID"`
	OSSAccessSecret string `env:"OSS_ACCESS_SECRET"`
	OSSBucket       string `env:"OSS_BUCKET"`
	OSSPathPrefix   string `env:"OSS_PATH_PREFIX" default:"/dice/cmdb/files"`

	CentralNexusPublicURL string `env:"NEXUS_PUBLIC_URL" required:"true"`
	CentralNexusAddr      string `env:"NEXUS_ADDR" required:"true"`
	CentralNexusUsername  string `env:"NEXUS_USERNAME" required:"true"`
	CentralNexusPassword  string `env:"NEXUS_PASSWORD" required:"true"`

	DiceClusterName string `env:"DICE_CLUSTER_NAME" required:"true"`

	// rsa
	Base64EncodedRsaPublicKey  string `` /* 1114-byte string literal not displayed */
	Base64EncodedRsaPrivateKey string `` /* 4363-byte string literal not displayed */

	// ory/kratos config
	OryEnabled           bool   `default:"false" env:"ORY_ENABLED"`
	OryKratosAddr        string `default:"kratos:4433" env:"KRATOS_ADDR"`
	OryKratosPrivateAddr string `default:"kratos:4434" env:"KRATOS_PRIVATE_ADDR"`
}

Conf 定义基于环境变量的配置项

Jump to

Keyboard shortcuts

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