config

Documentation

Overview

Example (UnmarshalInitConfig)

package main

import (
	"openpitrix.io/openpitrix/pkg/config"
	"openpitrix.io/openpitrix/pkg/logger"
)

func main() {
	globalConfig := config.DecodeInitConfig()
	logger.Info(nil, "Got global config: \n%+v\n", globalConfig)
	logger.Info(nil, "Get global config string: \n%s\n", config.EncodeGlobalConfig(globalConfig))
}

Index

• Constants
• func EncodeGlobalConfig(conf GlobalConfig) string
• func GetFlagSet() *flag.FlagSet
• func ParseFlag()
• func PrintUsage()
• type AppServiceConfig
• type AttachmentConfig
• type BasicConfig
• type ClusterServiceConfig
• type Config
  • func GetConf() *Config
• type EtcdConfig
• type GlobalConfig
  • func DecodeInitConfig() GlobalConfig
  • func ParseGlobalConfig(data []byte) (GlobalConfig, error)
  • func (g *GlobalConfig) GetAppDefaultStatus() string
  • func (g *GlobalConfig) GetRuntimeImageIdAndUrl(apiServer, zone string) (*RuntimeProviderConfig, error)
  • func (g *GlobalConfig) RegisterRuntimeProviderConfig(provider, config string) error
• type GrpcConfig
• type IAMConfig
• type InstallModuleConfig
• type JobServiceConfig
• type LogConfig
• type MysqlConfig
  • func (m *MysqlConfig) GetUrl() string
• type PilotServiceConfig
• type RepoServiceConfig
• type RuntimeProviderConfig
  • func ParseRuntimeProviderConfig(data []byte) (*RuntimeProviderConfig, error)
  • func (r *RuntimeProviderConfig) GetEnable() bool
  • func (r *RuntimeProviderConfig) GetHost(provider string) string
  • func (r *RuntimeProviderConfig) GetPort() int
• type TaskServiceConfig

Examples

• Package (UnmarshalInitConfig)

Constants

const InitialGlobalConfig = `` /* 1476-byte string literal not displayed */

Functions

func EncodeGlobalConfig

func EncodeGlobalConfig(conf GlobalConfig) string

func GetFlagSet

func GetFlagSet() *flag.FlagSet

func ParseFlag

func ParseFlag()

func PrintUsage

func PrintUsage()

Types

type AppServiceConfig

type AppServiceConfig struct {
	DefaultDraftStatus bool `json:"default_draft_status"`
}

type AttachmentConfig

type AttachmentConfig struct {
	AccessKey  string `default:"openpitrixminioaccesskey"`
	SecretKey  string `default:"openpitrixminiosecretkey"`
	Endpoint   string `default:"http://openpitrix-minio:9000"`
	BucketName string `default:"openpitrix-attachment"`
}

type BasicConfig

type BasicConfig struct {
	PlatformName string `json:"platform_name"`
	PlatformUrl  string `json:"platform_url"`
}

type ClusterServiceConfig

type ClusterServiceConfig struct {
	FrontgateConf       string `json:"frontgate_conf"`
	FrontgateAutoDelete bool   `json:"frontgate_auto_delete"`
	FrontgateAutoUpdate bool   `json:"frontgate_auto_update"`
	RegistryMirror      string `json:"registry_mirror"`
}

type Config

type Config struct {
	Log         LogConfig
	Grpc        GrpcConfig
	Mysql       MysqlConfig
	Etcd        EtcdConfig
	IAM         IAMConfig
	Attachment  AttachmentConfig
	DisableGops bool `default:"false"`
}

func GetConf

func GetConf() *Config

type EtcdConfig

type EtcdConfig struct {
	Endpoints string `default:"openpitrix-etcd:2379"` // Example: "localhost:2379,localhost:22379,localhost:32379"
}

type GlobalConfig

type GlobalConfig struct {
	App             AppServiceConfig                  `json:"app"`
	Repo            RepoServiceConfig                 `json:"repo"`
	Cluster         ClusterServiceConfig              `json:"cluster"`
	RuntimeProvider map[string]*RuntimeProviderConfig `json:"runtime_provider"`
	Pilot           PilotServiceConfig                `json:"pilot"`
	Job             JobServiceConfig                  `json:"job"`
	Task            TaskServiceConfig                 `json:"task"`
	BasicCfg        BasicConfig                       `json:"basic_config"`
	InstallModule   InstallModuleConfig               `json:"install_module"`
}

func DecodeInitConfig

func DecodeInitConfig() GlobalConfig

func ParseGlobalConfig

func ParseGlobalConfig(data []byte) (GlobalConfig, error)

func (*GlobalConfig) GetAppDefaultStatus

func (g *GlobalConfig) GetAppDefaultStatus() string

func (*GlobalConfig) GetRuntimeImageIdAndUrl

func (g *GlobalConfig) GetRuntimeImageIdAndUrl(apiServer, zone string) (*RuntimeProviderConfig, error)

func (*GlobalConfig) RegisterRuntimeProviderConfig

func (g *GlobalConfig) RegisterRuntimeProviderConfig(provider, config string) error

type GrpcConfig

type GrpcConfig struct {
	ShowErrorCause bool `default:"false"` // show grpc error cause to frontend
}

type IAMConfig

type IAMConfig struct {
	SecretKey              string        `default:"OpenPitrix-lC4LipAXPYsuqw5F"`
	ExpireTime             time.Duration `default:"2h"`
	RefreshTokenExpireTime time.Duration `default:"336h"` // default is 2 week
}

type InstallModuleConfig

type InstallModuleConfig struct {
	Iam          bool `json:"iam"`
	Notification bool `json:"notification"`
}

type JobServiceConfig

type JobServiceConfig struct {
	MaxWorkingJobs int32 `json:"max_working_jobs"`
}

type LogConfig

type LogConfig struct {
	Level string `default:"info"` // debug, info, warn, error, fatal
}

type MysqlConfig

type MysqlConfig struct {
	Host     string `default:"openpitrix-db"`
	Port     string `default:"3306"`
	User     string `default:"root"`
	Password string `default:"password"`
	Database string `default:"openpitrix"`
	Disable  bool   `default:"false"`
}

func (*MysqlConfig) GetUrl

func (m *MysqlConfig) GetUrl() string

type PilotServiceConfig

type PilotServiceConfig struct {
	Ip   string `json:"ip"`
	Port int32  `json:"port"`
}

type RepoServiceConfig

type RepoServiceConfig struct {
	Cron          string `json:"cron"`
	MaxRepoEvents int32  `json:"max_repo_events"`
}

type RuntimeProviderConfig

type RuntimeProviderConfig struct {
	ApiServer       string                 `json:"api_server"`
	Zone            string                 `json:"zone"`
	ImageId         string                 `json:"image_id"`
	ImageUrl        string                 `json:"image_url"`
	ImageName       string                 `json:"image_name"`
	FrontgateConf   string                 `json:"frontgate_conf"`
	ProviderType    string                 `json:"provider_type"`
	Host            string                 `json:"host"`
	Port            int                    `json:"port"`
	Enable          bool                   `json:"enable"`
	AdvancedOptions map[string]interface{} `json:"advanced_options"`
}

func ParseRuntimeProviderConfig

func ParseRuntimeProviderConfig(data []byte) (*RuntimeProviderConfig, error)

func (*RuntimeProviderConfig) GetEnable

func (r *RuntimeProviderConfig) GetEnable() bool

func (*RuntimeProviderConfig) GetHost

func (r *RuntimeProviderConfig) GetHost(provider string) string

func (*RuntimeProviderConfig) GetPort

func (r *RuntimeProviderConfig) GetPort() int

type TaskServiceConfig

type TaskServiceConfig struct {
	MaxWorkingTasks int32 `json:"max_working_tasks"`
}