Documentation
¶
Index ¶
- type NginxManager
- type Orchestrator
- func (o *Orchestrator) GetDeploymentProxyStatus(deployment *models.Deployment) *ProxyStatus
- func (o *Orchestrator) GetExpiringCertificates(days int) ([]models.Certificate, error)
- func (o *Orchestrator) ListCertificates() ([]models.Certificate, error)
- func (o *Orchestrator) ListVirtualHosts() ([]nginx.VirtualHostInfo, error)
- func (o *Orchestrator) NginxManager() *nginx.Manager
- func (o *Orchestrator) RenderDeployment(deployment *models.Deployment) (string, error)
- func (o *Orchestrator) RenewCertificate(domain string, force bool) (*ssl.RenewalResult, error)
- func (o *Orchestrator) RenewCertificates() (*ssl.RenewalResult, error)
- func (o *Orchestrator) RenewCertificatesForDomains(domains []string) *ssl.MultiCertificateResult
- func (o *Orchestrator) RequestCertificate(domain string) (*ssl.CertificateResult, error)
- func (o *Orchestrator) SSLManager() *ssl.Manager
- func (o *Orchestrator) SetupDeployment(deployment *models.Deployment) (*SetupResult, error)
- func (o *Orchestrator) TeardownDeployment(deploymentName string) error
- func (o *Orchestrator) UpdateConfig(cfg *config.Config)
- func (o *Orchestrator) UpdateDeployment(deployment *models.Deployment) (*SetupResult, error)
- type ProxyStatus
- type SSLManager
- type SetupResult
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type NginxManager ¶ added in v0.1.5
type NginxManager interface {
CreateVirtualHost(deployment *models.Deployment) error
UpdateVirtualHost(deployment *models.Deployment) error
DeleteVirtualHost(deploymentName string) error
VirtualHostExists(deploymentName string) bool
GetVirtualHost(deploymentName string) (string, error)
WriteVirtualHost(deploymentName string, content string) error
TestConfig() error
Reload() error
}
type Orchestrator ¶
type Orchestrator struct {
// contains filtered or unexported fields
}
func NewOrchestrator ¶
func NewOrchestrator(cfg *config.Config) *Orchestrator
func NewOrchestratorWithManagers ¶ added in v0.1.5
func NewOrchestratorWithManagers(nginxMgr *nginx.Manager, sslMgr *ssl.Manager) *Orchestrator
func (*Orchestrator) GetDeploymentProxyStatus ¶
func (o *Orchestrator) GetDeploymentProxyStatus(deployment *models.Deployment) *ProxyStatus
func (*Orchestrator) GetExpiringCertificates ¶
func (o *Orchestrator) GetExpiringCertificates(days int) ([]models.Certificate, error)
func (*Orchestrator) ListCertificates ¶
func (o *Orchestrator) ListCertificates() ([]models.Certificate, error)
func (*Orchestrator) ListVirtualHosts ¶
func (o *Orchestrator) ListVirtualHosts() ([]nginx.VirtualHostInfo, error)
func (*Orchestrator) NginxManager ¶
func (o *Orchestrator) NginxManager() *nginx.Manager
func (*Orchestrator) RenderDeployment ¶ added in v0.3.0
func (o *Orchestrator) RenderDeployment(deployment *models.Deployment) (string, error)
RenderDeployment returns the virtual host content SetupDeployment would install, applying the same SSL downgrade for missing certificates, without writing or reloading anything. Returns "" when the deployment is not exposed.
func (*Orchestrator) RenewCertificate ¶ added in v0.2.0
func (o *Orchestrator) RenewCertificate(domain string, force bool) (*ssl.RenewalResult, error)
func (*Orchestrator) RenewCertificates ¶
func (o *Orchestrator) RenewCertificates() (*ssl.RenewalResult, error)
func (*Orchestrator) RenewCertificatesForDomains ¶ added in v0.2.0
func (o *Orchestrator) RenewCertificatesForDomains(domains []string) *ssl.MultiCertificateResult
func (*Orchestrator) RequestCertificate ¶
func (o *Orchestrator) RequestCertificate(domain string) (*ssl.CertificateResult, error)
func (*Orchestrator) SSLManager ¶
func (o *Orchestrator) SSLManager() *ssl.Manager
func (*Orchestrator) SetupDeployment ¶
func (o *Orchestrator) SetupDeployment(deployment *models.Deployment) (*SetupResult, error)
func (*Orchestrator) TeardownDeployment ¶
func (o *Orchestrator) TeardownDeployment(deploymentName string) error
func (*Orchestrator) UpdateConfig ¶ added in v0.1.5
func (o *Orchestrator) UpdateConfig(cfg *config.Config)
func (*Orchestrator) UpdateDeployment ¶
func (o *Orchestrator) UpdateDeployment(deployment *models.Deployment) (*SetupResult, error)
type ProxyStatus ¶
type ProxyStatus struct {
DeploymentName string `json:"deployment_name"`
Exposed bool `json:"exposed"`
Domain string `json:"domain,omitempty"`
Domains []string `json:"domains,omitempty"`
DomainConfigs []models.DomainConfig `json:"domains_config,omitempty"`
VirtualHostExists bool `json:"virtual_host_exists"`
SSLEnabled bool `json:"ssl_enabled"`
CertificateExists bool `json:"certificate_exists"`
Certificate *models.Certificate `json:"certificate,omitempty"`
Certificates []models.Certificate `json:"certificates,omitempty"`
}
type SSLManager ¶ added in v0.1.5
type SSLManager interface {
ValidateDomain(domain string) error
CertificateExists(domain string) bool
RequestCertificate(domain string) (*ssl.CertificateResult, error)
GetCertificate(domain string) (*models.Certificate, error)
RenewCertificates() (*ssl.RenewalResult, error)
RenewCertificate(domain string) (*ssl.RenewalResult, error)
ListCertificates() ([]models.Certificate, error)
GetExpiringCertificates(days int) ([]models.Certificate, error)
SetAutoRenew(domain string, enabled bool) error
}
type SetupResult ¶
type SetupResult struct {
DeploymentName string `json:"deployment_name"`
Domain string `json:"domain,omitempty"`
Domains []string `json:"domains,omitempty"`
Success bool `json:"success"`
Skipped bool `json:"skipped"`
Message string `json:"message,omitempty"`
VirtualHostCreated bool `json:"virtual_host_created"`
NginxReloaded bool `json:"nginx_reloaded"`
CertificateRequested bool `json:"certificate_requested"`
CertificateExists bool `json:"certificate_exists"`
CertificateResults []*ssl.CertificateResult `json:"certificate_results,omitempty"`
SSLMessage string `json:"ssl_message,omitempty"`
SSLError string `json:"ssl_error,omitempty"`
TargetWarnings []string `json:"target_warnings,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.