Documentation
¶
Index ¶
- Constants
- Variables
- func IsRecordNotFoundError(err error) bool
- type Access
- type AccessConfigForACMEHttpReq
- type AccessConfigForAWS
- type AccessConfigForAliyun
- type AccessConfigForAzure
- type AccessConfigForBaiduCloud
- type AccessConfigForBytePlus
- type AccessConfigForCloudflare
- type AccessConfigForDogeCloud
- type AccessConfigForEdgio
- type AccessConfigForGoDaddy
- type AccessConfigForHuaweiCloud
- type AccessConfigForKubernetes
- type AccessConfigForLocal
- type AccessConfigForNS1
- type AccessConfigForNameDotCom
- type AccessConfigForNameSilo
- type AccessConfigForPowerDNS
- type AccessConfigForQiniu
- type AccessConfigForSSH
- type AccessConfigForTencentCloud
- type AccessConfigForUCloud
- type AccessConfigForVolcEngine
- type AccessConfigForWebhook
- type AccessProviderType
- type AcmeAccount
- type ApplyDNSProviderType
- type Certificate
- type CertificateSourceType
- type DeployProviderType
- type Error
- type Meta
- type NotifyChannelType
- type NotifyChannelsSettingsContent
- type NotifyTemplate
- type NotifyTemplatesSettingsContent
- type NotifyTestPushReq
- type Settings
- type Statistics
- type Workflow
- type WorkflowNode
- type WorkflowNodeIO
- type WorkflowNodeIOValueSelector
- type WorkflowNodeType
- type WorkflowOutput
- type WorkflowRun
- type WorkflowRunLog
- type WorkflowRunLogOutput
- type WorkflowRunLogs
- type WorkflowRunReq
- type WorkflowRunStatusType
- type WorkflowTriggerType
Constants ¶
View Source
const ( CertificateSourceTypeWorkflow = CertificateSourceType("workflow") CertificateSourceTypeUpload = CertificateSourceType("upload") )
View Source
const ( NotifyChannelTypeBark = NotifyChannelType("bark") NotifyChannelTypeDingTalk = NotifyChannelType("dingtalk") NotifyChannelTypeEmail = NotifyChannelType("email") NotifyChannelTypeLark = NotifyChannelType("lark") NotifyChannelTypeServerChan = NotifyChannelType("serverchan") NotifyChannelTypeTelegram = NotifyChannelType("telegram") NotifyChannelTypeWebhook = NotifyChannelType("webhook") NotifyChannelTypeWeCom = NotifyChannelType("wecom") )
消息通知渠道常量值。
注意:如果追加新的常量值,请保持以 ASCII 排序。 NOTICE: If you add new constant, please keep ASCII order.
View Source
const ( AccessProviderTypeACMEHttpReq = AccessProviderType("acmehttpreq") AccessProviderTypeAliyun = AccessProviderType("aliyun") AccessProviderTypeAWS = AccessProviderType("aws") AccessProviderTypeAzure = AccessProviderType("azure") AccessProviderTypeBaiduCloud = AccessProviderType("baiducloud") AccessProviderTypeBytePlus = AccessProviderType("byteplus") AccessProviderTypeCloudflare = AccessProviderType("cloudflare") AccessProviderTypeDogeCloud = AccessProviderType("dogecloud") AccessProviderTypeEdgio = AccessProviderType("edgio") AccessProviderTypeGoDaddy = AccessProviderType("godaddy") AccessProviderTypeHuaweiCloud = AccessProviderType("huaweicloud") AccessProviderTypeKubernetes = AccessProviderType("k8s") AccessProviderTypeLocal = AccessProviderType("local") AccessProviderTypeNameDotCom = AccessProviderType("namedotcom") AccessProviderTypeNameSilo = AccessProviderType("namesilo") AccessProviderTypeNS1 = AccessProviderType("ns1") AccessProviderTypePowerDNS = AccessProviderType("powerdns") AccessProviderTypeQiniu = AccessProviderType("qiniu") AccessProviderTypeSSH = AccessProviderType("ssh") AccessProviderTypeTencentCloud = AccessProviderType("tencentcloud") AccessProviderTypeUCloud = AccessProviderType("ucloud") AccessProviderTypeVolcEngine = AccessProviderType("volcengine") AccessProviderTypeWebhook = AccessProviderType("webhook") )
授权提供商类型常量值。
注意:如果追加新的常量值,请保持以 ASCII 排序。 NOTICE: If you add new constant, please keep ASCII order.
View Source
const ( ApplyDNSProviderTypeACMEHttpReq = ApplyDNSProviderType("acmehttpreq") ApplyDNSProviderTypeAliyun = ApplyDNSProviderType("aliyun") // 兼容旧值,等同于 [ApplyDNSProviderTypeAliyunDNS] ApplyDNSProviderTypeAliyunDNS = ApplyDNSProviderType("aliyun-dns") ApplyDNSProviderTypeAWS = ApplyDNSProviderType("aws") // 兼容旧值,等同于 [ApplyDNSProviderTypeAWSRoute53] ApplyDNSProviderTypeAWSRoute53 = ApplyDNSProviderType("aws-route53") ApplyDNSProviderTypeAzureDNS = ApplyDNSProviderType("azure-dns") ApplyDNSProviderTypeCloudflare = ApplyDNSProviderType("cloudflare") ApplyDNSProviderTypeGoDaddy = ApplyDNSProviderType("godaddy") ApplyDNSProviderTypeHuaweiCloud = ApplyDNSProviderType("huaweicloud") // 兼容旧值,等同于 [ApplyDNSProviderTypeHuaweiCloudDNS] ApplyDNSProviderTypeHuaweiCloudDNS = ApplyDNSProviderType("huaweicloud-dns") ApplyDNSProviderTypeNameDotCom = ApplyDNSProviderType("namedotcom") ApplyDNSProviderTypeNameSilo = ApplyDNSProviderType("namesilo") ApplyDNSProviderTypeNS1 = ApplyDNSProviderType("ns1") ApplyDNSProviderTypePowerDNS = ApplyDNSProviderType("powerdns") ApplyDNSProviderTypeTencentCloud = ApplyDNSProviderType("tencentcloud") // 兼容旧值,等同于 [ApplyDNSProviderTypeTencentCloudDNS] ApplyDNSProviderTypeTencentCloudDNS = ApplyDNSProviderType("tencentcloud-dns") ApplyDNSProviderTypeVolcEngine = ApplyDNSProviderType("volcengine") // 兼容旧值,等同于 [ApplyDNSProviderTypeVolcEngineDNS] ApplyDNSProviderTypeVolcEngineDNS = ApplyDNSProviderType("volcengine-dns") )
申请证书 DNS 提供商常量值。 短横线前的部分始终等于授权提供商类型。
注意:如果追加新的常量值,请保持以 ASCII 排序。 NOTICE: If you add new constant, please keep ASCII order.
View Source
const ( DeployProviderTypeAliyunALB = DeployProviderType("aliyun-alb") DeployProviderTypeAliyunCDN = DeployProviderType("aliyun-cdn") DeployProviderTypeAliyunCLB = DeployProviderType("aliyun-clb") DeployProviderTypeAliyunDCDN = DeployProviderType("aliyun-dcdn") DeployProviderTypeAliyunLive = DeployProviderType("aliyun-live") DeployProviderTypeAliyunNLB = DeployProviderType("aliyun-nlb") DeployProviderTypeAliyunOSS = DeployProviderType("aliyun-oss") DeployProviderTypeBaiduCloudCDN = DeployProviderType("baiducloud-cdn") DeployProviderTypeBytePlusCDN = DeployProviderType("byteplus-cdn") DeployProviderTypeDogeCloudCDN = DeployProviderType("dogecloud-cdn") DeployProviderTypeEdgioApplications = DeployProviderType("edgio-applications") DeployProviderTypeHuaweiCloudCDN = DeployProviderType("huaweicloud-cdn") DeployProviderTypeHuaweiCloudELB = DeployProviderType("huaweicloud-elb") DeployProviderTypeKubernetesSecret = DeployProviderType("k8s-secret") DeployProviderTypeLocal = DeployProviderType("local") DeployProviderTypeQiniuCDN = DeployProviderType("qiniu-cdn") DeployProviderTypeSSH = DeployProviderType("ssh") DeployProviderTypeTencentCloudCDN = DeployProviderType("tencentcloud-cdn") DeployProviderTypeTencentCloudCLB = DeployProviderType("tencentcloud-clb") DeployProviderTypeTencentCloudCOS = DeployProviderType("tencentcloud-cos") DeployProviderTypeTencentCloudCSS = DeployProviderType("tencentcloud-css") DeployProviderTypeTencentCloudECDN = DeployProviderType("tencentcloud-ecdn") DeployProviderTypeTencentCloudEO = DeployProviderType("tencentcloud-eo") DeployProviderTypeUCloudUCDN = DeployProviderType("ucloud-ucdn") DeployProviderTypeUCloudUS3 = DeployProviderType("ucloud-us3") DeployProviderTypeVolcEngineCDN = DeployProviderType("volcengine-cdn") DeployProviderTypeVolcEngineCLB = DeployProviderType("volcengine-clb") DeployProviderTypeVolcEngineDCDN = DeployProviderType("volcengine-dcdn") DeployProviderTypeVolcEngineLive = DeployProviderType("volcengine-live") DeployProviderTypeVolcEngineTOS = DeployProviderType("volcengine-tos") DeployProviderTypeWebhook = DeployProviderType("webhook") )
部署目标提供商常量值。 短横线前的部分始终等于授权提供商类型。
注意:如果追加新的常量值,请保持以 ASCII 排序。 NOTICE: If you add new constant, please keep ASCII order.
View Source
const ( WorkflowNodeTypeStart = WorkflowNodeType("start") WorkflowNodeTypeEnd = WorkflowNodeType("end") WorkflowNodeTypeApply = WorkflowNodeType("apply") WorkflowNodeTypeDeploy = WorkflowNodeType("deploy") WorkflowNodeTypeNotify = WorkflowNodeType("notify") WorkflowNodeTypeBranch = WorkflowNodeType("branch") WorkflowNodeTypeCondition = WorkflowNodeType("condition") )
View Source
const ( WorkflowTriggerTypeAuto = WorkflowTriggerType("auto") WorkflowTriggerTypeManual = WorkflowTriggerType("manual") )
View Source
const WORKFLOW_OUTPUT_CERTIFICATE = "certificate"
Variables ¶
View Source
var ( ErrInvalidParams = NewError(400, "invalid params") ErrRecordNotFound = NewError(404, "record not found") )
Functions ¶
func IsRecordNotFoundError ¶ added in v0.3.0
Types ¶
type Access ¶ added in v0.3.0
type AccessConfigForACMEHttpReq ¶ added in v0.3.0
type AccessConfigForAWS ¶ added in v0.3.0
type AccessConfigForAliyun ¶ added in v0.3.0
type AccessConfigForAzure ¶ added in v0.3.0
type AccessConfigForBaiduCloud ¶ added in v0.3.0
type AccessConfigForBytePlus ¶ added in v0.3.0
type AccessConfigForCloudflare ¶ added in v0.3.0
type AccessConfigForCloudflare struct {
DnsApiToken string `json:"dnsApiToken"`
}
type AccessConfigForDogeCloud ¶ added in v0.3.0
type AccessConfigForEdgio ¶ added in v0.3.0
type AccessConfigForGoDaddy ¶ added in v0.3.0
type AccessConfigForHuaweiCloud ¶ added in v0.3.0
type AccessConfigForKubernetes ¶ added in v0.3.0
type AccessConfigForKubernetes struct {
KubeConfig string `json:"kubeConfig,omitempty"`
}
type AccessConfigForLocal ¶ added in v0.3.0
type AccessConfigForLocal struct{}
type AccessConfigForNS1 ¶ added in v0.3.0
type AccessConfigForNS1 struct {
ApiKey string `json:"apiKey"`
}
type AccessConfigForNameDotCom ¶ added in v0.3.0
type AccessConfigForNameSilo ¶ added in v0.3.0
type AccessConfigForNameSilo struct {
ApiKey string `json:"apiKey"`
}
type AccessConfigForPowerDNS ¶ added in v0.3.0
type AccessConfigForQiniu ¶ added in v0.3.0
type AccessConfigForSSH ¶ added in v0.3.0
type AccessConfigForTencentCloud ¶ added in v0.3.0
type AccessConfigForUCloud ¶ added in v0.3.0
type AccessConfigForVolcEngine ¶ added in v0.3.0
type AccessConfigForWebhook ¶ added in v0.3.0
type AccessConfigForWebhook struct {
Url string `json:"url"`
}
type AccessProviderType ¶ added in v0.3.0
type AccessProviderType string
type AcmeAccount ¶ added in v0.2.8
type ApplyDNSProviderType ¶ added in v0.3.0
type ApplyDNSProviderType string
type Certificate ¶ added in v0.3.0
type Certificate struct {
Meta
Source CertificateSourceType `json:"source" db:"source"`
SubjectAltNames string `json:"subjectAltNames" db:"subjectAltNames"`
Certificate string `json:"certificate" db:"certificate"`
PrivateKey string `json:"privateKey" db:"privateKey"`
IssuerCertificate string `json:"issuerCertificate" db:"issuerCertificate"`
EffectAt time.Time `json:"effectAt" db:"effectAt"`
ExpireAt time.Time `json:"expireAt" db:"expireAt"`
ACMECertUrl string `json:"acmeCertUrl" db:"acmeCertUrl"`
ACMECertStableUrl string `json:"acmeCertStableUrl" db:"acmeCertStableUrl"`
WorkflowId string `json:"workflowId" db:"workflowId"`
WorkflowNodeId string `json:"workflowNodeId" db:"workflowNodeId"`
WorkflowOutputId string `json:"workflowOutputId" db:"workflowOutputId"`
DeletedAt *time.Time `json:"deleted" db:"deleted"`
}
type CertificateSourceType ¶ added in v0.3.0
type CertificateSourceType string
type DeployProviderType ¶ added in v0.3.0
type DeployProviderType string
type NotifyChannelType ¶ added in v0.3.0
type NotifyChannelType string
type NotifyChannelsSettingsContent ¶ added in v0.3.0
type NotifyTemplate ¶ added in v0.3.0
type NotifyTemplatesSettingsContent ¶ added in v0.3.0
type NotifyTemplatesSettingsContent struct {
NotifyTemplates []NotifyTemplate `json:"notifyTemplates"`
}
type NotifyTestPushReq ¶
type NotifyTestPushReq struct {
Channel string `json:"channel"`
}
type Settings ¶ added in v0.3.0
type Statistics ¶ added in v0.3.0
type Statistics struct {
CertificateTotal int `json:"certificateTotal"`
CertificateExpireSoon int `json:"certificateExpireSoon"`
CertificateExpired int `json:"certificateExpired"`
WorkflowTotal int `json:"workflowTotal"`
WorkflowEnabled int `json:"workflowEnabled"`
WorkflowDisabled int `json:"workflowDisabled"`
}
type Workflow ¶ added in v0.3.0
type Workflow struct {
Meta
Name string `json:"name" db:"name"`
Description string `json:"description" db:"description"`
Trigger WorkflowTriggerType `json:"trigger" db:"trigger"`
TriggerCron string `json:"triggerCron" db:"triggerCron"`
Enabled bool `json:"enabled" db:"enabled"`
Content *WorkflowNode `json:"content" db:"content"`
Draft *WorkflowNode `json:"draft" db:"draft"`
HasDraft bool `json:"hasDraft" db:"hasDraft"`
LastRunId string `json:"lastRunId" db:"lastRunId"`
LastRunStatus WorkflowRunStatusType `json:"lastRunStatus" db:"lastRunStatus"`
LastRunTime time.Time `json:"lastRunTime" db:"lastRunTime"`
}
type WorkflowNode ¶ added in v0.3.0
type WorkflowNode struct {
Id string `json:"id"`
Type WorkflowNodeType `json:"type"`
Name string `json:"name"`
Config map[string]any `json:"config"`
Inputs []WorkflowNodeIO `json:"inputs"`
Outputs []WorkflowNodeIO `json:"outputs"`
Next *WorkflowNode `json:"next"`
Branches []WorkflowNode `json:"branches"`
Validated bool `json:"validated"`
}
func (*WorkflowNode) GetConfigBool ¶
func (n *WorkflowNode) GetConfigBool(key string) bool
func (*WorkflowNode) GetConfigInt32 ¶
func (n *WorkflowNode) GetConfigInt32(key string) int32
func (*WorkflowNode) GetConfigInt64 ¶
func (n *WorkflowNode) GetConfigInt64(key string) int64
func (*WorkflowNode) GetConfigMap ¶
func (n *WorkflowNode) GetConfigMap(key string) map[string]any
func (*WorkflowNode) GetConfigString ¶
func (n *WorkflowNode) GetConfigString(key string) string
type WorkflowNodeIO ¶ added in v0.3.0
type WorkflowNodeIOValueSelector ¶ added in v0.3.0
type WorkflowNodeType ¶ added in v0.3.0
type WorkflowNodeType string
type WorkflowOutput ¶ added in v0.3.0
type WorkflowOutput struct {
Meta
WorkflowId string `json:"workflowId" db:"workflow"`
NodeId string `json:"nodeId" db:"nodeId"`
Node *WorkflowNode `json:"node" db:"node"`
Outputs []WorkflowNodeIO `json:"outputs" db:"outputs"`
Succeeded bool `json:"succeeded" db:"succeeded"`
}
type WorkflowRun ¶ added in v0.3.0
type WorkflowRun struct {
Meta
WorkflowId string `json:"workflowId" db:"workflowId"`
Status WorkflowRunStatusType `json:"status" db:"status"`
Trigger WorkflowTriggerType `json:"trigger" db:"trigger"`
StartedAt time.Time `json:"startedAt" db:"startedAt"`
EndedAt time.Time `json:"endedAt" db:"endedAt"`
Logs []WorkflowRunLog `json:"logs" db:"logs"`
Error string `json:"error" db:"error"`
}
type WorkflowRunLog ¶ added in v0.3.0
type WorkflowRunLog struct {
NodeId string `json:"nodeId"`
NodeName string `json:"nodeName"`
Error string `json:"error"`
Outputs []WorkflowRunLogOutput `json:"outputs"`
}
type WorkflowRunLogOutput ¶
type WorkflowRunLogs ¶ added in v0.3.0
type WorkflowRunLogs []WorkflowRunLog
func (WorkflowRunLogs) FirstError ¶
func (r WorkflowRunLogs) FirstError() string
type WorkflowRunReq ¶
type WorkflowRunReq struct {
WorkflowId string `json:"workflowId"`
Trigger WorkflowTriggerType `json:"trigger"`
}
type WorkflowRunStatusType ¶ added in v0.3.0
type WorkflowRunStatusType string
const ( WorkflowRunStatusTypePending WorkflowRunStatusType = "pending" WorkflowRunStatusTypeRunning WorkflowRunStatusType = "running" WorkflowRunStatusTypeSucceeded WorkflowRunStatusType = "succeeded" WorkflowRunStatusTypeFailed WorkflowRunStatusType = "failed" )
type WorkflowTriggerType ¶ added in v0.3.0
type WorkflowTriggerType string
Click to show internal directories.
Click to hide internal directories.