Documentation ¶
Index ¶
- Constants
- Variables
- func CleanSkippedList() []string
- func CollieAPIAddress() string
- func CustomDNSNotSupported() bool
- func DefaultIngressClass() string
- func DefaultRecycleDay() int
- func DindImage() string
- func DockerHosts() []string
- func EnableGitCheck() bool
- func ExecutorImage() string
- func Features() string
- func GithubKnownHost() string
- func GithubSSHKey() string
- func Home() string
- func HubAgentImage() string
- func HubServerAddress() string
- func JenkinsImage() string
- func KodespaceVersion() string
- func KubeServerAddr() string
- func LocalDeliveryChartPathWithRevision(project, service string, revision int64) string
- func LocalProductionDeliveryChartPathWithRevision(project, service string, revision int64) string
- func LocalProductionServicePath(project, service string) string
- func LocalProductionServicePathWithRevision(project, service string, version string) string
- func LocalServicePath(project, service string, production bool) string
- func LocalServicePathWithRevision(project, service string, version string, production bool) string
- func LocalTestServicePath(project, service string) string
- func LocalTestServicePathWithRevision(project, service string, revision string) string
- func LogLevel() int
- func MongoDatabase() string
- func MongoURI() string
- func MysqlDexDB() string
- func MysqlUserDB() string
- func Namespace() string
- func ObjectStorageProductionServicePath(project, service string) string
- func ObjectStorageServicePath(project, service string, production bool) string
- func ObjectStorageTestServicePath(project, service string) string
- func OldEnvSupported() bool
- func PackagerImage() string
- func PodName() string
- func PredatorImage() string
- func ProxyHTTPAddr() string
- func ProxyHTTPSAddr() string
- func ProxySocks5Addr() string
- func ReaperBinaryFile() string
- func ReaperImage() string
- func RegistryAccessKey() string
- func RegistryAddress() string
- func RegistryNamespace() string
- func RegistrySecretKey() string
- func S3StorageAK() string
- func S3StorageBucket() string
- func S3StorageEndpoint() string
- func S3StoragePath() string
- func S3StorageProtocol() string
- func S3StorageSK() string
- func ServiceAccountNameForUser(userID string) string
- func ServiceNameWithRevision(serviceName string, revision int64) string
- func ServiceStartTimeout() int
- func SetProxy(HTTPSAddr, HTTPAddr, Socks5Addr string)
- func UseClassicBuild() bool
- func WebHookURL() string
- type ApprovalType
- type ApproveOrReject
- type CommonEnvCfgType
- type DeployContent
- type DeploySourceType
- type DistributeType
- type EnvType
- type HookEventType
- type JiraAuthType
- type JobRunPolicy
- type JobType
- type NotifyType
- type ParamSourceType
- type PipelineType
- type ProductAuthType
- type ProductPermission
- type ProjectType
- type RegistryProvider
- type ScheduleType
- type SlackNotifyType
- type StageType
- type Status
- type StepType
- type TaskStatus
- type TaskType
- type TestModuleType
- type TriggerWorkflowSourceType
- type WorkflowTriggerType
- type ZadigXReleaseType
Constants ¶
const ( ServiceNameRegexString = "^[a-zA-Z0-9-_]+$" ConfigNameRegexString = "^[a-zA-Z0-9-]+$" ImageRegexString = "^[a-zA-Z0-9.:\\/-]+$" CVMNameRegexString = "^[a-zA-Z_]\\w+$" EnvRecyclePolicyAlways = "always" EnvRecyclePolicyTaskStatus = "success" EnvRecyclePolicyNever = "never" // 定时器的所属job类型 WorkflowCronjob = "workflow" WorkflowV4Cronjob = "workflow_v4" TestingCronjob = "test" EnvAnalysisCronjob = "env_analysis" )
const ( ZadigIstioCopySuffix = "zadig-copy" ZadigLastAppliedImage = "last-applied-image" ZadigLastAppliedReplicas = "last-applied-replicas" )
const ( EnvTypeTest = "test" EvnTypeProduction = "production" )
const ( // ProductReadPermission ... ProductReadPermission = ProductPermission("read") // ProductWritePermission ... ProductWritePermission = ProductPermission("write") )
const ( // ProductAuthUser ... ProductAuthUser = ProductAuthType("user") // ProductAuthTeam ... ProductAuthTeam = ProductAuthType("team") )
const ( HookEventPush = HookEventType("push") HookEventPr = HookEventType("pull_request") HookEventTag = HookEventType("tag") HookEventUpdated = HookEventType("ref-updated") )
const ( KeyStateNew = "new" KeyStateUnused = "unused" KeyStatePresent = "present" )
const ( Day = 7 LatestDay = 10 Date = "2006-01-02" )
const ( RegistryTypeSWR = "swr" RegistryTypeAWS = "ecr" )
const ( ImageResourceType = "image" TarResourceType = "tar" )
const ( RoleBindingNameEdit = setting.ProductName + "-edit" RoleBindingNameView = setting.ProductName + "-view" )
const ( BlueGreenVerionLabelName = "zadig-blue-green-version" BlueServiceNameSuffix = "-zadig-blue" OriginVersion = "origin" )
for custom blue-green release job
const ( GrayLabelKey = "zadig-gray-release" GrayLabelValue = "released-by-zadig" GrayImageAnnotationKey = "zadig-gray-release-image" GrayContainerAnnotationKey = "zadig-gray-release-container" GrayReplicaAnnotationKey = "zadig-gray-release-replica" GrayDeploymentSuffix = "-zadig-gray" )
for custom gray release job
const ( ProjectTypeHelm = "helm" ProjectTypeYaml = "yaml" ProjectTypeVM = "vm" ProjectTypeLoaded = "loaded" )
const ( ParamSourceRuntime = "runtime" ParamSourceFixed = "fixed" ParamSourceGlobal = "global" )
const ( RegistryProviderACR = "acr" RegistryProviderSWR = "swr" RegistryProviderTCR = "tcr" RegistryProviderHarbor = "harbor" RegistryProviderDockerhub = "dockerhub" RegistryProviderECR = "ecr" RegistryProviderNative = "native" )
const ( TestJobJunitReportStepName = "junit-report-step" TestJobHTMLReportStepName = "html-report-step" TestJobArchiveResultStepName = "archive-result-step" TestJobObjectStorageStepName = "object-storage-step" )
const ( SourceFromTemplate = "template" SourceFromYaml = "yaml" )
Service creation source for openAPI
const ( DashboardDataTypeTestPassRate = "test_pass_rate" DashboardDataTypeTestAverageDuration = "test_average_duration" DashboardDataTypeBuildSuccessRate = "build_success_rate" DashboardDataTypeBuildAverageDuration = "build_average_duration" DashboardDataTypeBuildFrequency = "build_frequency" DashboardDataTypeDeploySuccessRate = "deploy_success_rate" DashboardDataTypeDeployAverageDuration = "deploy_average_duration" DashboardDataTypeDeployFrequency = "deploy_frequency" DashboardDataTypeReleaseSuccessRate = "release_success_rate" DashboardDataTypeReleaseAverageDuration = "release_average_duration" DashboardDataTypeReleaseFrequency = "release_frequency" DashboardDataSourceZadig = "zadig" DashboardDataSourceApi = "api" DashboardDataCategoryQuality = "quality" DashboardDataCategoryEfficiency = "efficiency" DashboardDataCategorySchedule = "schedule" DashboardFunctionBuildAverageDuration = "5400/(x+540)" DashboardFunctionBuildSuccessRate = "-2400/(x-120)-20" DashboardFunctionDeploySuccessRate = "-2400/(x-120)-20" DashboardFunctionDeployFrequency = "100-40000/(3*x+400)" DashboardFunctionTestPassRate = "(x**2)/80-x/4+1.25" DashboardFunctionTestAverageDuration = "90000/(x+900)" DashboardFunctionReleaseFrequency = "100-200/(x+2)" )
statistics dashboard id enum
const (
CUSTOME_THEME = "custom"
)
const DefaultDeleteDeploymentTimeout = 10 * time.Minute
const (
NameSpaceRegexString = "[^a-z0-9.-]"
)
Validation constants
Variables ¶
var ( // RenderTemplateAlias ... RenderTemplateAlias = regexp.MustCompile(`{{\s?\.\w+\s?}}`) ServiceNameAlias = regexp.MustCompile(`\$Service\$`) ProductNameAlias = regexp.MustCompile(`\$Product\$`) NameSpaceRegex = regexp.MustCompile(NameSpaceRegexString) )
var ( ServiceNameRegex = regexp.MustCompile(ServiceNameRegexString) ConfigNameRegex = regexp.MustCompile(ConfigNameRegexString) ImageRegex = regexp.MustCompile(ImageRegexString) CVMNameRegex = regexp.MustCompile(CVMNameRegexString) )
Functions ¶
func CleanSkippedList ¶
func CleanSkippedList() []string
CleanIgnoredList is a list which will be ignored during environment cleanup.
func CollieAPIAddress ¶
func CollieAPIAddress() string
func CustomDNSNotSupported ¶
func CustomDNSNotSupported() bool
func DefaultIngressClass ¶
func DefaultIngressClass() string
func DockerHosts ¶
func DockerHosts() []string
func EnableGitCheck ¶
func EnableGitCheck() bool
func ExecutorImage ¶ added in v1.9.9
func ExecutorImage() string
func GithubKnownHost ¶
func GithubKnownHost() string
func GithubSSHKey ¶
func GithubSSHKey() string
func HubAgentImage ¶
func HubAgentImage() string
func HubServerAddress ¶
func HubServerAddress() string
func JenkinsImage ¶
func JenkinsImage() string
func KodespaceVersion ¶
func KodespaceVersion() string
func KubeServerAddr ¶
func KubeServerAddr() string
func LocalDeliveryChartPathWithRevision ¶ added in v1.8.0
LocalDeliveryChartPathWithRevision returns the path of the normal service with the specific revision
func LocalProductionDeliveryChartPathWithRevision ¶ added in v1.9.9
func LocalProductionServicePath ¶ added in v1.9.9
LocalProductionServicePath returns the path of the production service with the latest version
func LocalProductionServicePathWithRevision ¶ added in v1.9.9
LocalProductionServicePathWithRevision returns the path of the normal service with the specific revision
func LocalServicePath ¶ added in v1.4.0
func LocalServicePathWithRevision ¶ added in v1.7.1
func LocalTestServicePath ¶ added in v1.9.9
LocalTestServicePath returns the path of the normal service with the latest version
func LocalTestServicePathWithRevision ¶ added in v1.9.9
LocalTestServicePathWithRevision returns the path of the normal service with the specific revision
func MongoDatabase ¶
func MongoDatabase() string
func MysqlDexDB ¶ added in v1.9.9
func MysqlDexDB() string
func MysqlUserDB ¶ added in v1.9.9
func MysqlUserDB() string
func ObjectStorageProductionServicePath ¶ added in v1.9.9
func ObjectStorageServicePath ¶ added in v1.4.0
func ObjectStorageTestServicePath ¶ added in v1.9.9
func OldEnvSupported ¶
func OldEnvSupported() bool
func PackagerImage ¶ added in v1.8.0
func PackagerImage() string
func PredatorImage ¶
func PredatorImage() string
func ProxyHTTPAddr ¶
func ProxyHTTPAddr() string
func ProxyHTTPSAddr ¶
func ProxyHTTPSAddr() string
func ProxySocks5Addr ¶
func ProxySocks5Addr() string
func ReaperBinaryFile ¶
func ReaperBinaryFile() string
func ReaperImage ¶
func ReaperImage() string
func RegistryAccessKey ¶
func RegistryAccessKey() string
func RegistryAddress ¶
func RegistryAddress() string
func RegistryNamespace ¶
func RegistryNamespace() string
func RegistrySecretKey ¶
func RegistrySecretKey() string
func S3StorageAK ¶
func S3StorageAK() string
func S3StorageBucket ¶
func S3StorageBucket() string
func S3StorageEndpoint ¶
func S3StorageEndpoint() string
func S3StorageProtocol ¶
func S3StorageProtocol() string
func S3StorageSK ¶
func S3StorageSK() string
func ServiceAccountNameForUser ¶ added in v1.7.1
func ServiceNameWithRevision ¶ added in v1.7.1
func UseClassicBuild ¶
func UseClassicBuild() bool
func WebHookURL ¶ added in v1.2.0
func WebHookURL() string
Types ¶
type ApprovalType ¶ added in v1.9.9
type ApprovalType string
const ( NativeApproval ApprovalType = "native" LarkApproval ApprovalType = "lark" DingTalkApproval ApprovalType = "dingtalk" )
type ApproveOrReject ¶ added in v1.9.9
type ApproveOrReject string
const ( Approve ApproveOrReject = "approve" Reject ApproveOrReject = "reject" )
type CommonEnvCfgType ¶ added in v1.9.9
type CommonEnvCfgType string
const ( CommonEnvCfgTypeIngress CommonEnvCfgType = "Ingress" CommonEnvCfgTypeConfigMap CommonEnvCfgType = "ConfigMap" CommonEnvCfgTypeSecret CommonEnvCfgType = "Secret" CommonEnvCfgTypePvc CommonEnvCfgType = "PVC" )
type DeployContent ¶ added in v1.9.9
type DeployContent string
const ( DeployImage DeployContent = "image" DeployVars DeployContent = "vars" DeployConfig DeployContent = "config" )
type DeploySourceType ¶ added in v1.9.9
type DeploySourceType string
const ( SourceRuntime DeploySourceType = "runtime" SourceFromJob DeploySourceType = "fromjob" )
type DistributeType ¶
type DistributeType string
const ( File DistributeType = "file" Image DistributeType = "image" Chart DistributeType = "chart" )
type HookEventType ¶
type HookEventType string
type JiraAuthType ¶ added in v1.9.9
type JiraAuthType string
const ( JiraBasicAuth JiraAuthType = "password_or_token" JiraPersonalAccessToken JiraAuthType = "personal_access_token" )
type JobRunPolicy ¶ added in v1.9.9
type JobRunPolicy string
const ( DefaultRun JobRunPolicy = "" // default run this job DefaultNotRun JobRunPolicy = "default_not_run" // default not run this job ForceRun JobRunPolicy = "force_run" // force run this job )
type JobType ¶ added in v1.9.9
type JobType string
const ( JobBuild JobType = "build" JobDeploy JobType = "deploy" JobZadigBuild JobType = "zadig-build" JobZadigDistributeImage JobType = "zadig-distribute-image" JobZadigTesting JobType = "zadig-test" JobZadigScanning JobType = "zadig-scanning" JobCustomDeploy JobType = "custom-deploy" JobZadigDeploy JobType = "zadig-deploy" JobZadigHelmDeploy JobType = "zadig-helm-deploy" JobZadigHelmChartDeploy JobType = "zadig-helm-chart-deploy" JobFreestyle JobType = "freestyle" JobPlugin JobType = "plugin" JobK8sBlueGreenDeploy JobType = "k8s-blue-green-deploy" JobK8sBlueGreenRelease JobType = "k8s-blue-green-release" JobK8sCanaryDeploy JobType = "k8s-canary-deploy" JobK8sCanaryRelease JobType = "k8s-canary-release" JobK8sGrayRelease JobType = "k8s-gray-release" JobK8sGrayRollback JobType = "k8s-gray-rollback" JobK8sPatch JobType = "k8s-resource-patch" JobIstioRelease JobType = "istio-release" JobIstioRollback JobType = "istio-rollback" JobJira JobType = "jira" JobNacos JobType = "nacos" JobApollo JobType = "apollo" JobMeegoTransition JobType = "meego-transition" JobWorkflowTrigger JobType = "workflow-trigger" JobOfflineService JobType = "offline-service" JobMseGrayRelease JobType = "mse-gray-release" JobMseGrayOffline JobType = "mse-gray-offline" )
type NotifyType ¶
type NotifyType int
var ( Announcement NotifyType = 1 // 公告 PipelineStatus NotifyType = 2 // 提醒 Message NotifyType = 3 // 消息 )
type ParamSourceType ¶ added in v1.9.9
type ParamSourceType string
type PipelineType ¶
type PipelineType string
Type pipeline type
const ( // SingleType 单服务工作流 SingleType PipelineType = "single" // WorkflowType 多服务工作流 WorkflowType PipelineType = "workflow" // FreestyleType 自由编排工作流 FreestyleType PipelineType = "freestyle" // TestType 测试 TestType PipelineType = "test" // ServiceType 服务 ServiceType PipelineType = "service" // WorkflowTypeV3 WorkflowTypeV3 PipelineType = "workflow_v3" // WorkflowTypeV4 WorkflowTypeV4 PipelineType = "workflow_v4" // ArtifactPackageType package artifact ArtifactType PipelineType = "artifact" // ScanningType is the type for scanning ScanningType PipelineType = "scanning" )
type ProjectType ¶ added in v1.9.9
type ProjectType string
type RegistryProvider ¶ added in v1.9.9
type RegistryProvider string
type ScheduleType ¶
type ScheduleType string
ScheduleType 触发模式
const ( // TimingSchedule 定时循环 TimingSchedule ScheduleType = "timing" // GapSchedule 间隔循环 GapSchedule ScheduleType = "gap" )
type SlackNotifyType ¶
type SlackNotifyType string
const ( // SlackAll SlackNotifyType = "all" SlackOnChange SlackNotifyType = "onchange" SlackOnfailure SlackNotifyType = "onfailure" )
type Status ¶
type Status string
const ( StatusDisabled Status = "disabled" StatusCreated Status = "created" StatusRunning Status = "running" StatusPassed Status = "passed" StatusSkipped Status = "skipped" StatusFailed Status = "failed" StatusTimeout Status = "timeout" StatusCancelled Status = "cancelled" StatusWaiting Status = "waiting" StatusQueued Status = "queued" StatusBlocked Status = "blocked" QueueItemPending Status = "pending" StatusChanged Status = "changed" StatusNotRun Status = "notRun" StatusPrepare Status = "prepare" StatusReject Status = "reject" StatusWaitingApprove Status = "waitforapprove" StatusDebugBefore Status = "debug_before" StatusDebugAfter Status = "debug_after" )
func InCompletedStatus ¶ added in v1.9.9
func InCompletedStatus() []Status
type StepType ¶ added in v1.9.9
type StepType string
const ( StepTools StepType = "tools" StepShell StepType = "shell" StepGit StepType = "git" StepDockerBuild StepType = "docker_build" StepDeploy StepType = "deploy" StepHelmDeploy StepType = "helm_deploy" StepCustomDeploy StepType = "custom_deploy" StepImageDistribute StepType = "image_distribute" StepArchive StepType = "archive" StepArchiveDistribute StepType = "archive_distribute" StepJunitReport StepType = "junit_report" StepHtmlReport StepType = "html_report" StepTarArchive StepType = "tar_archive" StepSonarCheck StepType = "sonar_check" StepDistributeImage StepType = "distribute_image" StepDebugBefore StepType = "debug_before" StepDebugAfter StepType = "debug_after" )
type TaskStatus ¶
type TaskStatus string
const ( TaskStatusRunning TaskStatus = "running" TaskStatusCompleted TaskStatus = "completed" TaskStatusReady TaskStatus = "ready" TaskStatusFailed TaskStatus = "failed" TaskStatusTimeout TaskStatus = "timeout" TaskStatusCancelled TaskStatus = "cancelled" TaskStatusPass TaskStatus = "pass" )
type TaskType ¶
type TaskType string
const ( TaskPipeline TaskType = "pipeline" TaskBuild TaskType = "buildv2" TaskBuildV3 TaskType = "buildv3" TaskJenkinsBuild TaskType = "jenkins_build" TaskArtifact TaskType = "artifact" TaskArtifactDeploy TaskType = "artifact_deploy" TaskDeploy TaskType = "deploy" TaskTestingV2 TaskType = "testingv2" TaskScanning TaskType = "scanning" TaskDistributeToS3 TaskType = "distribute2kodo" TaskReleaseImage TaskType = "release_image" TaskJira TaskType = "jira" TaskDockerBuild TaskType = "docker_build" TaskSecurity TaskType = "security" TaskResetImage TaskType = "reset_image" TaskDistribute TaskType = "distribute" TaskTrigger TaskType = "trigger" TaskExtension TaskType = "extension" TaskArtifactPackage TaskType = "artifact_package" )
type TestModuleType ¶ added in v1.9.9
type TestModuleType string
const ( ProductTestType TestModuleType = "" ServiceTestType TestModuleType = "service_test" )
type TriggerWorkflowSourceType ¶ added in v1.9.9
type TriggerWorkflowSourceType string
const ( TriggerWorkflowSourceRuntime TriggerWorkflowSourceType = "runtime" TriggerWorkflowSourceFromJob TriggerWorkflowSourceType = "fromjob" )
type WorkflowTriggerType ¶ added in v1.9.9
type WorkflowTriggerType string
const ( WorkflowTriggerTypeCommon WorkflowTriggerType = "common" WorkflowTriggerTypeFixed WorkflowTriggerType = "fixed" )
type ZadigXReleaseType ¶ added in v1.18.0
type ZadigXReleaseType string
var (
ZadigXMseGrayRelease ZadigXReleaseType = "mse-gray"
)