haproxymanager

Documentation

Index

• func GenerateSecuredPasswordForBasicAuthentication(password string) (string, error)
• func IsPortRestrictedForManualConfig(port int, restrictedPorts []int) bool
• type BackendProtocol
• type ListenerMode
• type Manager
  • func New(connCreator func() (net.Conn, error), username string, password string) Manager
  • func (s Manager) AddBackend(transactionId string, backendProtocol BackendProtocol, serviceName string, ...) (string, error)
  • func (s Manager) AddBackendSwitch(transactionId string, listenerMode ListenerMode, bindPort int, ...) error
  • func (s Manager) AddFrontend(transactionId string, listenerMode ListenerMode, bindPort int, ...) error
  • func (s Manager) AddHTTPLink(transactionId string, backendName string, domainName string) error
  • func (s Manager) AddHTTPRedirectRule(transactionId string, matchDomain string, redirectUrl string) error
  • func (s Manager) AddHTTPSLink(transactionId string, backendName string, domainName string) error
  • func (s Manager) AddHTTPSRedirectRule(transactionId string, matchDomain string, redirectUrl string) error
  • func (s Manager) AddTCPLink(transactionId string, backendName string, port int, domainName string, ...) error
  • func (s Manager) AddUserInUserList(transactionId string, userListName string, username string, ...) error
  • func (s Manager) AddUserList(transactionId string, userListName string) error
  • func (s Manager) ChangeUserPasswordInUserList(transactionId string, userListName string, username string, ...) error
  • func (s Manager) CommitTransaction(transactionId string) error
  • func (s Manager) DeleteBackend(transactionId string, backendName string) error
  • func (s Manager) DeleteBackendSwitch(transactionId string, listenerMode ListenerMode, bindPort int, ...) error
  • func (s Manager) DeleteFrontend(transactionId string, listenerMode ListenerMode, bindPort int) error
  • func (s Manager) DeleteHTTPLink(transactionId string, backendName string, domainName string) error
  • func (s Manager) DeleteHTTPRedirectRule(transactionId string, matchDomain string) error
  • func (s Manager) DeleteHTTPSLink(transactionId string, backendName string, domainName string) error
  • func (s Manager) DeleteHTTPSRedirectRule(transactionId string, matchDomain string) error
  • func (s Manager) DeleteTCPLink(transactionId string, backendName string, port int, domainName string, ...) error
  • func (s Manager) DeleteTransaction(transactionId string) error
  • func (s Manager) DeleteUserFromUserList(transactionId string, userListName string, username string) error
  • func (s Manager) DeleteUserList(transactionId string, userListName string) error
  • func (s Manager) DisableHTTPSRedirection(transactionId string, domainName string) error
  • func (s Manager) EnableHTTPSRedirection(transactionId string, domainName string) error
  • func (s Manager) FetchBackendSwitchIndex(transactionId string, listenerMode ListenerMode, bindPort int, ...) (int, error)
  • func (s Manager) FetchIndexOfHTTPSRedirection(transactionId string, domainName string) (int, error)
  • func (s Manager) FetchNewTransactionId() (string, error)
  • func (s Manager) GenerateBackendName(backendProtocol BackendProtocol, serviceName string, port int) string
  • func (s Manager) GenerateFrontendName(listenerMode ListenerMode, port int) string
  • func (s Manager) GetReplicaCount(transactionId string, backendProtocol BackendProtocol, serviceName string, ...) (int, error)
  • func (s Manager) IsBackendExist(transactionId string, backendName string) (bool, error)
  • func (s Manager) IsFrontendExist(transactionId string, listenerMode ListenerMode, bindPort int) (bool, error)
  • func (s Manager) IsOtherSwitchingRuleExist(transactionId string, listenerMode ListenerMode, bindPort int) (bool, error)
  • func (s Manager) IsUserExistInUserList(transactionId string, userListName string, username string) (bool, error)
  • func (s Manager) IsUserListExist(transactionId string, userListName string) (bool, error)
  • func (s Manager) RemoveBasicAuthentication(transactionId string, listenerMode ListenerMode, bindPort int, domain string, ...) (returnedError error)
  • func (s Manager) SetupBasicAuthentication(transactionId string, listenerMode ListenerMode, bindPort int, domain string, ...) error
  • func (s Manager) URI() string
  • func (s Manager) UpdateBackendReplicas(transactionId string, backendProtocol BackendProtocol, serviceName string, ...) error
  • func (s Manager) UpdateSSL(transactionId string, domain string, privateKey []byte, fullChain []byte) error
• type QueryParameter
• type QueryParameters

Functions

func GenerateSecuredPasswordForBasicAuthentication

func GenerateSecuredPasswordForBasicAuthentication(password string) (string, error)

func IsPortRestrictedForManualConfig

func IsPortRestrictedForManualConfig(port int, restrictedPorts []int) bool

IsPortRestrictedForManualConfig : This function is used to check if a port is restricted or not for application.

There are some ports that are restricted. because those port are pre-occupied by Swarm services or other required services. So, binding to those ports will cause errors. That's why we need to restrict those ports before apply the config.

Types

type BackendProtocol

type BackendProtocol string

const (
	HTTPBackend BackendProtocol = "http"
	TCPBackend  BackendProtocol = "tcp"
)

type ListenerMode

type ListenerMode string

const (
	HTTPMode ListenerMode = "http"
	TCPMode  ListenerMode = "tcp"
)

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

func New

func New(connCreator func() (net.Conn, error), username string, password string) Manager

New : Constructor for new instance of haproxy manager

func (Manager) AddBackend

func (s Manager) AddBackend(transactionId string, backendProtocol BackendProtocol, serviceName string, port int, replicas int) (string, error)

AddBackend : Add Backend to HAProxy configuration -- Manage server template with backend

func (Manager) AddBackendSwitch

func (s Manager) AddBackendSwitch(transactionId string, listenerMode ListenerMode, bindPort int, backendName string, domainName string) error

func (Manager) AddFrontend

func (s Manager) AddFrontend(transactionId string, listenerMode ListenerMode, bindPort int, restrictedPorts []int) error

func (Manager) AddHTTPLink

func (s Manager) AddHTTPLink(transactionId string, backendName string, domainName string) error

AddHTTPLink Add HTTP Link [Backend Switch] to HAProxy configuration -- Manage ACLs with frontend [only domain_name] -- Manage rules with frontend and backend switch

func (Manager) AddHTTPRedirectRule

func (s Manager) AddHTTPRedirectRule(transactionId string, matchDomain string, redirectUrl string) error

AddHTTPRedirectRule Add HTTP Redirect Rule

func (Manager) AddHTTPSLink

func (s Manager) AddHTTPSLink(transactionId string, backendName string, domainName string) error

AddHTTPSLink Add HTTPS Link [Backend Switch] to HAProxy configuration -- Manage ACLs with frontend [only domain_name] -- Manage rules with frontend and backend switch

func (Manager) AddHTTPSRedirectRule

func (s Manager) AddHTTPSRedirectRule(transactionId string, matchDomain string, redirectUrl string) error

AddHTTPSRedirectRule Add HTTPS Redirect Rule

func (Manager) AddTCPLink

func (s Manager) AddTCPLink(transactionId string, backendName string, port int, domainName string, listenerMode ListenerMode, restrictedPorts []int) error

AddTCPLink Add TCP Frontend to HAProxy configuration -- Manage ACLs with frontend [port{required} and domain_name{optional}] -- Manage rules with frontend and backend switch

func (Manager) AddUserInUserList

func (s Manager) AddUserInUserList(transactionId string, userListName string, username string, encryptedPassword string) error

func (Manager) AddUserList

func (s Manager) AddUserList(transactionId string, userListName string) error

func (Manager) ChangeUserPasswordInUserList

func (s Manager) ChangeUserPasswordInUserList(transactionId string, userListName string, username string, encryptedPassword string) error

func (Manager) CommitTransaction

func (s Manager) CommitTransaction(transactionId string) error

CommitTransaction : Commit new transaction with force reload to apply changes

func (Manager) DeleteBackend

func (s Manager) DeleteBackend(transactionId string, backendName string) error

DeleteBackend Delete Backend from HAProxy configuration

func (Manager) DeleteBackendSwitch

func (s Manager) DeleteBackendSwitch(transactionId string, listenerMode ListenerMode, bindPort int, backendName string, domainName string) error

func (Manager) DeleteFrontend

func (s Manager) DeleteFrontend(transactionId string, listenerMode ListenerMode, bindPort int) error

func (Manager) DeleteHTTPLink

func (s Manager) DeleteHTTPLink(transactionId string, backendName string, domainName string) error

DeleteHTTPLink Delete HTTP Link from HAProxy configuration

func (Manager) DeleteHTTPRedirectRule

func (s Manager) DeleteHTTPRedirectRule(transactionId string, matchDomain string) error

DeleteHTTPRedirectRule Delete HTTP Redirect Rule

func (Manager) DeleteHTTPSLink

func (s Manager) DeleteHTTPSLink(transactionId string, backendName string, domainName string) error

DeleteHTTPSLink Delete HTTPS Link from HAProxy configuration

func (Manager) DeleteHTTPSRedirectRule

func (s Manager) DeleteHTTPSRedirectRule(transactionId string, matchDomain string) error

DeleteHTTPSRedirectRule Delete HTTPS Redirect Rule

func (Manager) DeleteTCPLink

func (s Manager) DeleteTCPLink(transactionId string, backendName string, port int, domainName string, listenerMode ListenerMode) error

DeleteTCPLink Delete TCP Frontend from HAProxy configuration

func (Manager) DeleteTransaction

func (s Manager) DeleteTransaction(transactionId string) error

DeleteTransaction : Delete transaction

func (Manager) DeleteUserFromUserList

func (s Manager) DeleteUserFromUserList(transactionId string, userListName string, username string) error

func (Manager) DeleteUserList

func (s Manager) DeleteUserList(transactionId string, userListName string) error

func (Manager) DisableHTTPSRedirection

func (s Manager) DisableHTTPSRedirection(transactionId string, domainName string) error

func (Manager) EnableHTTPSRedirection

func (s Manager) EnableHTTPSRedirection(transactionId string, domainName string) error

func (Manager) FetchBackendSwitchIndex

func (s Manager) FetchBackendSwitchIndex(transactionId string, listenerMode ListenerMode, bindPort int, backendName string, domainName string) (int, error)

func (Manager) FetchIndexOfHTTPSRedirection

func (s Manager) FetchIndexOfHTTPSRedirection(transactionId string, domainName string) (int, error)

func (Manager) FetchNewTransactionId

func (s Manager) FetchNewTransactionId() (string, error)

FetchNewTransactionId : Generate new transaction id

func (Manager) GenerateBackendName

func (s Manager) GenerateBackendName(backendProtocol BackendProtocol, serviceName string, port int) string

GenerateBackendName : Generate Backend name for HAProxy

func (Manager) GenerateFrontendName

func (s Manager) GenerateFrontendName(listenerMode ListenerMode, port int) string

func (Manager) GetReplicaCount

func (s Manager) GetReplicaCount(transactionId string, backendProtocol BackendProtocol, serviceName string, port int) (int, error)

GetReplicaCount : Fetch Backend Replicas -- Manage server template with backend

func (Manager) IsBackendExist

func (s Manager) IsBackendExist(transactionId string, backendName string) (bool, error)

IsBackendExist : Check backend exist in HAProxy configuration

func (Manager) IsFrontendExist

func (s Manager) IsFrontendExist(transactionId string, listenerMode ListenerMode, bindPort int) (bool, error)

func (Manager) IsOtherSwitchingRuleExist

func (s Manager) IsOtherSwitchingRuleExist(transactionId string, listenerMode ListenerMode, bindPort int) (bool, error)

func (Manager) IsUserExistInUserList

func (s Manager) IsUserExistInUserList(transactionId string, userListName string, username string) (bool, error)

func (Manager) IsUserListExist

func (s Manager) IsUserListExist(transactionId string, userListName string) (bool, error)

func (Manager) RemoveBasicAuthentication

func (s Manager) RemoveBasicAuthentication(transactionId string, listenerMode ListenerMode, bindPort int, domain string, userListName string) (returnedError error)

func (Manager) SetupBasicAuthentication

func (s Manager) SetupBasicAuthentication(transactionId string, listenerMode ListenerMode, bindPort int, domain string, userListName string) error

func (Manager) URI

func (s Manager) URI() string

URI Generate Base URI for HAProxy Server

func (Manager) UpdateBackendReplicas

func (s Manager) UpdateBackendReplicas(transactionId string, backendProtocol BackendProtocol, serviceName string, port int, replicas int) error

UpdateBackendReplicas : Update Backend Replicas -- Manage server template with backend

func (Manager) UpdateSSL

func (s Manager) UpdateSSL(transactionId string, domain string, privateKey []byte, fullChain []byte) error

UpdateSSL : Add SSL certificate to HAProxy

type QueryParameter

type QueryParameter struct {
	// contains filtered or unexported fields
}

type QueryParameters

type QueryParameters []QueryParameter