Documentation
¶
Index ¶
Constants ¶
const ConnectionErrorMsg = "failed to connect to internal Pages API"
ConnectionErrorMsg to be returned with `gc.Status` if Pages fails to connect to the internal GitLab API, times out or a 401 given that the credentials used are wrong
Variables ¶
ErrUnauthorizedAPI is returned when resolving a domain with the GitLab API returns a http.StatusUnauthorized. This happens if the common secret file is not synced between gitlab-pages and gitlab-rails servers. See https://gitlab.com/gitlab-org/gitlab-pages/-/issues/535 for more details.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a HTTP client to access Pages internal API
func NewClient ¶
func NewClient(baseURL string, secretKey []byte, connectionTimeout, jwtTokenExpiry time.Duration) (*Client, error)
NewClient initializes and returns new Client baseUrl is appConfig.InternalGitLabServer secretKey is appConfig.GitLabAPISecretKey
func NewFromConfig ¶
NewFromConfig creates a new client from Config struct
func (*Client) GetLookup ¶
GetLookup returns a VirtualDomain configuration wrapped into a Lookup for a given host
type Config ¶
type Config interface { InternalGitLabServerURL() string GitlabAPISecret() []byte GitlabClientConnectionTimeout() time.Duration GitlabJWTTokenExpiry() time.Duration DomainConfigSource() string Cache() *config.Cache }
Config represents an interface that is configuration provider for client capable of comunicating with GitLab
type StubClient ¶
StubClient is a stubbed client used for testing
func (StubClient) Status ¶ added in v1.22.0
func (c StubClient) Status() error