package
0.20.4
Repository: https://github.com/keptn/go-utils.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author

# Functions

AppendQuery returns an option function that can modify an URI by appending a map of url query values.
No description provided by the author
New creates a new APISet instance.
NewAPIHandler returns a new APIHandler.
NewAPIHandlerWithHTTPClient returns a new APIHandler that uses the specified http.Client.
NewAuthenticatedAPIHandler returns a new APIHandler that authenticates at the api-service endpoint via the provided token Deprecated: use APISet instead.
NewAuthenticatedAuthHandler returns a new AuthHandler that authenticates at the endpoint via the provided token Deprecated: use APISet instead.
NewAuthenticatedEventHandler returns a new EventHandler that authenticates at the endpoint via the provided token Deprecated: use APISet instead.
NewAuthenticatedLogHandler returns a new EventHandler that authenticates at the endpoint via the provided token Deprecated: use APISet instead.
NewAuthenticatedProjectHandler returns a new ProjectHandler that authenticates at the api via the provided token and sends all requests directly to the resource-service Deprecated: use APISet instead.
NewAuthenticatedResourceHandler returns a new ResourceHandler that authenticates at the api via the provided token and sends all requests directly to the resource-service Deprecated: use APISet instead.
NewAuthenticatedSecretHandler returns a new SecretHandler that authenticates at the api via the provided token and sends all requests directly to the secret-service Deprecated: use APISet instead.
NewAuthenticatedSequenceControlHandler returns a new SequenceControlHandler that authenticates at the api via the provided token Deprecated: use APISet instead.
NewAuthenticatedServiceHandler returns a new ServiceHandler that authenticates at the api via the provided token and sends all requests directly to the resource-service Deprecated: use APISet instead.
NewAuthenticatedShipyardControllerHandler returns a new ShipyardControllerHandler that authenticates at the api via the provided token and sends all requests directly to the resource-service Deprecated: use APISet instead.
NewAuthenticatedStageHandler returns a new StageHandler that authenticates at the api via the provided token and sends all requests directly to the resource-service Deprecated: use APISet instead.
NewAuthenticatedUniformHandler returns a new UniformHandler that authenticates at the api via the provided token Deprecated: use APISet instead.
NewAuthHandler returns a new AuthHandler.
NewAuthHandlerWithHTTPClient returns a new AuthHandler that uses the specified http.Client.
NewConfigurableSleeper creates a new instance of a configurable sleeper which will pause execution of the current thread for a given duration.
NewEventHandler returns a new EventHandler.
NewEventHandlerWithHTTPClient returns a new EventHandler that uses the specified http.Client.
NewEventWatcher creates a new event watcher with the given options.
NewFakeSleeper creates a new instance of a FakeSleeper.
NewInternal creates a new InternalAPISet usable for calling keptn services from within the control plane.
NewLogHandler returns a new LogHandler.
NewLogHandlerWithHTTPClient returns a new LogHandler that uses the specified http.Client.
NewProjectHandler returns a new ProjectHandler which sends all requests directly to the resource-service.
NewProjectHandlerWithHTTPClient returns a new ProjectHandler which sends all requests directly to the resource-service using the specified http.Client.
NewResourceHandler returns a new ResourceHandler which sends all requests directly to the resource-service.
NewResourceHandlerWithHTTPClient returns a new ResourceHandler which sends all requests directly to the resource-service using the specified http.Client.
NewResourceScope returns an empty ResourceScope to fill in calling Project Stage Service or Resource functions.
NewSecretHandler returns a new SecretHandler which sends all requests directly to the secret-service.
NewSecretHandlerWithHTTPClient returns a new SecretHandler which sends all requests directly to the secret-service using the specified http.Client.
NewSequenceControlHandler returns a new SequenceControlHandler.
NewSequenceControlHandlerWithHTTPClient returns a new SequenceControlHandler using the specified http.Client.
NewServiceHandler returns a new ServiceHandler which sends all requests directly to the resource-service.
NewServiceHandlerWithHTTPClient returns a new ServiceHandler which sends all requests directly to the resource-service using the specified http.Client.
NewShipyardControllerHandler returns a new ShipyardControllerHandler which sends all requests directly to the resource-service.
NewShipyardControllerHandlerWithHTTPClient returns a new ShipyardControllerHandler which sends all requests directly to the resource-service using the specified http.Client.
NewStageHandler returns a new StageHandler which sends all requests directly to the resource-service.
NewStageHandlerWithHTTPClient returns a new StageHandler which sends all requests directly to the resource-service using the specified http.Client.
NewUniformHandler returns a new UniformHandler.
NewUniformHandlerWithHTTPClient returns a new UniformHandler using the specified http.Client.
RunHealthEndpoint starts an http server on the specified port and provides a simple HTTP Get endpoint that can be used for health checks per default, the endpoint will be reachable under the path '/health'.
SortByTime sorts the event slice by time (oldest to newest).
WithAuthToken sets the given auth token.
WithEventFilter configures the EventWatcher to use a filter.
WithHTTPClient configures a custom http client to use.
WithInterval configures the EventWatcher to use a custom delay between each query You can use this to overwrite the default which is 10 * time.Second.
WithPath allows to specify the path under which the endpoint should be reachable.
WithReadinessConditionFunc allows to specify a function that should determine if the endpoint should return an HTTP 200 (OK), or a 412 (Precondition failed) response.
WithScheme sets the scheme If this option is not used, then default scheme "http" is used by the APISet.
WithStartTime configures the EventWatcher to use a specific start timestamp for the first query.
WithTimeout configures the EventWatcher to use a custom timeout specifying after which duration the watcher shall stop.

# Constants

No description provided by the author
No description provided by the author
ErrWithStatusCode message.
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

DefaultInClusterAPIMappings gives you the default InClusterAPIMappings.
No description provided by the author

# Structs

APIHandler handles projects.
APISet contains the API utils for all Keptn APIs.
AuthHandler handles projects.
ConfigurableSleeper is an implementation of a sleeper that can be configured to sleep for a specific duration.
EventFilter allows to filter events based on the provided properties.
EventHandler handles services.
EventWatcher implements the logic to query for events and provide them to the client.
FakeSleeper is a sleeper that does not sleep.
InternalAPIHandler is used instead of APIHandler from go-utils because we cannot support (unauthenticated) internal calls to the api-service at the moment.
InternalAPISet is an implementation of APISet which can be used from within the Keptn control plane.
No description provided by the author
ProjectHandler handles projects.
ResourceHandler handles resources.
ResourceScope contains the necessary information to get a resource.
SecretHandler handles services.
No description provided by the author
No description provided by the author
No description provided by the author
ServiceHandler handles services.
ShipyardControllerHandler handles services.
StageHandler handles stages.
No description provided by the author
No description provided by the author

# Interfaces

APIService represents the interface for accessing the configuration service.
No description provided by the author
No description provided by the author
EventHandlerInterface is the api to fetch events from the event store.
No description provided by the author
go:generate moq -pkg utils_mock -skip-ensure -out ./fake/log_handler_mock.go .
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
go:generate moq -pkg utils_mock -skip-ensure -out ./fake/secret_handler_mock.go .
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Sleeper defines the interface to sleep.
No description provided by the author
No description provided by the author

# Type aliases

EventManipulatorFunc can be used to manipulate a slice of events.
EventWatcherOption can be used to configure the EventWatcher.
No description provided by the author
InClusterAPIMappings maps a keptn service name to its reachable domain name.
InternalService is used to enumerate internal Keptn services.
No description provided by the author
URIOption returns a function that modifies an url.