api

package
v0.7.2-alpha Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 2, 2020 License: Apache-2.0 Imports: 17 Imported by: 82

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ResourceNotFoundError = errors.New("Resource not found")

Functions

func ResolveXipIo added in v0.2.4 

func ResolveXipIo(network, addr string) (net.Conn, error)

ResolveXipIo resolves a xip io address

func ResolveXipIoWithContext added in v0.2.4 

func ResolveXipIoWithContext(ctx context.Context, network, addr string) (net.Conn, error)

ResolveXipIoWithContext resolves a xip io address

func RunHealthEndpoint added in v0.7.0 

func RunHealthEndpoint(port string)

Types

type APIHandler added in v0.7.0 

type APIHandler struct {
	BaseURL    string
	AuthToken  string
	AuthHeader string
	HTTPClient *http.Client
	Scheme     string
}

APIHandler handles projects

func NewAuthenticatedAPIHandler added in v0.7.0 

func NewAuthenticatedAPIHandler(baseURL string, authToken string, authHeader string, httpClient *http.Client, scheme string) *APIHandler

NewAuthenticatedAPIHandler returns a new APIHandler that authenticates at the api-service endpoint via the provided token

func (*APIHandler) CreateProject added in v0.7.0 

func (p *APIHandler) CreateProject(project models.CreateProject) (*models.EventContext, *models.Error)

CreateProject creates a new project

func (*APIHandler) CreateService added in v0.7.0 

func (s *APIHandler) CreateService(project string, service models.CreateService) (*models.EventContext, *models.Error)

CreateService creates a new service

func (*APIHandler) DeleteProject added in v0.7.0 

func (p *APIHandler) DeleteProject(project models.Project) (*models.EventContext, *models.Error)

DeleteProject deletes a project

func (*APIHandler) DeleteService added in v0.7.1 

func (p *APIHandler) DeleteService(project, service string) (*models.EventContext, *models.Error)

DeleteProject deletes a project

func (*APIHandler) GetEvent deprecated added in v0.7.0 

func (e *APIHandler) GetEvent(keptnContext string, eventType string) (*models.KeptnContextExtendedCE, *models.Error)

GetEvent returns an event specified by keptnContext and eventType

Deprecated: this function is deprecated and should be replaced with the GetEvents function

func (*APIHandler) GetMetadata added in v0.7.0 

func (s *APIHandler) GetMetadata() (*models.Metadata, *models.Error)

GetMetadata retrieve keptn MetaData information

func (*APIHandler) SendEvent added in v0.7.0 

func (e *APIHandler) SendEvent(event models.KeptnContextExtendedCE) (*models.EventContext, *models.Error)

SendEvent sends an event to Keptn

func (*APIHandler) TriggerEvaluation added in v0.8.0 

func (e *APIHandler) TriggerEvaluation(project, stage, service string, evaluation models.Evaluation) (*models.EventContext, *models.Error)

TriggerEvaluation triggers a new evaluation

type APIService 

type APIService interface {
	// contains filtered or unexported methods
}

APIService represents the interface for accessing the configuration service

type AuthHandler 

type AuthHandler struct {
	BaseURL    string
	AuthToken  string
	AuthHeader string
	HTTPClient *http.Client
	Scheme     string
}

AuthHandler handles projects

func NewAuthHandler 

func NewAuthHandler(baseURL string) *AuthHandler

NewAuthHandler returns a new AuthHandler

func NewAuthenticatedAuthHandler 

func NewAuthenticatedAuthHandler(baseURL string, authToken string, authHeader string, httpClient *http.Client, scheme string) *AuthHandler

NewAuthenticatedAuthHandler returns a new AuthHandler that authenticates at the endpoint via the provided token

func (*AuthHandler) Authenticate 

func (a *AuthHandler) Authenticate() (*models.EventContext, *models.Error)

Authenticate authenticates the client request against the server

type EventFilter added in v0.7.0 

type EventFilter struct {
	Project       string
	Stage         string
	Service       string
	EventType     string
	KeptnContext  string
	EventID       string
	PageSize      string
	NumberOfPages int
}

EventFilter allows to filter events based on the provided properties

type EventHandler 

type EventHandler struct {
	BaseURL    string
	AuthToken  string
	AuthHeader string
	HTTPClient *http.Client
	Scheme     string
}

EventHandler handles services

func NewAuthenticatedEventHandler 

func NewAuthenticatedEventHandler(baseURL string, authToken string, authHeader string, httpClient *http.Client, scheme string) *EventHandler

NewAuthenticatedEventHandler returns a new EventHandler that authenticates at the endpoint via the provided token

func NewEventHandler 

func NewEventHandler(baseURL string) *EventHandler

NewEventHandler returns a new EventHandler

func (*EventHandler) GetEvents added in v0.7.0 

func (e *EventHandler) GetEvents(filter *EventFilter) ([]*models.KeptnContextExtendedCE, *models.Error)

GetEvents returns all events matching the properties in the passed filter object

type ProjectHandler 

type ProjectHandler struct {
	BaseURL    string
	AuthToken  string
	AuthHeader string
	HTTPClient *http.Client
	Scheme     string
}

ProjectHandler handles projects

func NewAuthenticatedProjectHandler 

func NewAuthenticatedProjectHandler(baseURL string, authToken string, authHeader string, httpClient *http.Client, scheme string) *ProjectHandler

NewAuthenticatedProjectHandler returns a new ProjectHandler that authenticates at the api via the provided token and sends all requests directly to the configuration-service

func NewProjectHandler 

func NewProjectHandler(baseURL string) *ProjectHandler

NewProjectHandler returns a new ProjectHandler which sends all requests directly to the configuration-service

func (*ProjectHandler) CreateProject 

func (p *ProjectHandler) CreateProject(project models.Project) (*models.EventContext, *models.Error)

CreateProject creates a new project

func (*ProjectHandler) DeleteProject 

func (p *ProjectHandler) DeleteProject(project models.Project) (*models.EventContext, *models.Error)

DeleteProject deletes a project

func (*ProjectHandler) GetAllProjects added in v0.6.2 

func (p *ProjectHandler) GetAllProjects() ([]*models.Project, error)

GetProjects returns a project

func (*ProjectHandler) GetProject 

func (p *ProjectHandler) GetProject(project models.Project) (*models.Project, *models.Error)

GetProject returns a project

func (*ProjectHandler) UpdateConfigurationServiceProject added in v0.7.0 

func (p *ProjectHandler) UpdateConfigurationServiceProject(project models.Project) (*models.EventContext, *models.Error)

type ResourceHandler 

type ResourceHandler struct {
	BaseURL    string
	AuthToken  string
	AuthHeader string
	HTTPClient *http.Client
	Scheme     string
}

ResourceHandler handles resources

func NewAuthenticatedResourceHandler 

func NewAuthenticatedResourceHandler(baseURL string, authToken string, authHeader string, httpClient *http.Client, scheme string) *ResourceHandler

NewAuthenticatedResourceHandler returns a new ResourceHandler that authenticates at the api via the provided token and sends all requests directly to the configuration-service

func NewResourceHandler 

func NewResourceHandler(baseURL string) *ResourceHandler

NewResourceHandler returns a new ResourceHandler which sends all requests directly to the configuration-service

func (*ResourceHandler) CreateProjectResources added in v0.6.2 

func (r *ResourceHandler) CreateProjectResources(project string, resources []*models.Resource) (string, error)

CreateProjectResources creates multiple project resources

func (*ResourceHandler) CreateResources added in v0.6.0 

func (r *ResourceHandler) CreateResources(project string, stage string, service string, resources []*models.Resource) (*models.EventContext, *models.Error)

CreateResources creates a resource for the specified entity

func (*ResourceHandler) CreateServiceResources 

func (r *ResourceHandler) CreateServiceResources(project string, stage string, service string, resources []*models.Resource) (string, error)

CreateServiceResources creates a service resource

func (*ResourceHandler) CreateStageResources added in v0.6.2 

func (r *ResourceHandler) CreateStageResources(project string, stage string, resources []*models.Resource) (string, error)

CreateStageResources creates a stage resource

func (*ResourceHandler) DeleteProjectResource added in v0.6.2 

func (r *ResourceHandler) DeleteProjectResource(project string, resourceURI string) error

DeleteProjectResource deletes a project resource

func (*ResourceHandler) DeleteServiceResource added in v0.6.2 

func (r *ResourceHandler) DeleteServiceResource(project string, stage string, service string, resourceURI string) error

DeleteServiceResource deletes a service resource

func (*ResourceHandler) DeleteStageResource added in v0.6.2 

func (r *ResourceHandler) DeleteStageResource(project string, stage string, resourceURI string) error

DeleteStageResource deletes a stage resource

func (*ResourceHandler) GetAllServiceResources added in v0.6.2 

func (r *ResourceHandler) GetAllServiceResources(project string, stage string, service string) ([]*models.Resource, error)

GetAllServiceResources returns a list of all resources.

func (*ResourceHandler) GetAllStageResources added in v0.6.2 

func (r *ResourceHandler) GetAllStageResources(project string, stage string) ([]*models.Resource, error)

GetAllStageResources returns a list of all resources.

func (*ResourceHandler) GetProjectResource added in v0.6.2 

func (r *ResourceHandler) GetProjectResource(project string, resourceURI string) (*models.Resource, error)

GetProjectResource retrieves a project resource from the configuration service

func (*ResourceHandler) GetServiceResource added in v0.6.2 

func (r *ResourceHandler) GetServiceResource(project string, stage string, service string, resourceURI string) (*models.Resource, error)

GetServiceResource retrieves a service resource from the configuration service

func (*ResourceHandler) GetStageResource added in v0.6.2 

func (r *ResourceHandler) GetStageResource(project string, stage string, resourceURI string) (*models.Resource, error)

GetStageResource retrieves a stage resource from the configuration service

func (*ResourceHandler) UpdateProjectResource added in v0.6.2 

func (r *ResourceHandler) UpdateProjectResource(project string, resource *models.Resource) (string, error)

UpdateProjectResource updates a project resource

func (*ResourceHandler) UpdateProjectResources added in v0.6.2 

func (r *ResourceHandler) UpdateProjectResources(project string, resources []*models.Resource) (string, error)

UpdateProjectResources updates multiple project resources

func (*ResourceHandler) UpdateServiceResource added in v0.6.2 

func (r *ResourceHandler) UpdateServiceResource(project string, stage string, service string, resource *models.Resource) (string, error)

UpdateServiceResource updates a service resource

func (*ResourceHandler) UpdateServiceResources added in v0.6.2 

func (r *ResourceHandler) UpdateServiceResources(project string, stage string, service string, resources []*models.Resource) (string, error)

UpdateServiceResources updates multiple service resources

func (*ResourceHandler) UpdateStageResource added in v0.6.2 

func (r *ResourceHandler) UpdateStageResource(project string, stage string, resource *models.Resource) (string, error)

UpdateStageResource updates a stage resource

func (*ResourceHandler) UpdateStageResources added in v0.6.2 

func (r *ResourceHandler) UpdateStageResources(project string, stage string, resources []*models.Resource) (string, error)

UpdateStageResources updates multiple stage resources

type ServiceHandler 

type ServiceHandler struct {
	BaseURL    string
	AuthToken  string
	AuthHeader string
	HTTPClient *http.Client
	Scheme     string
}

ServiceHandler handles services

func NewAuthenticatedServiceHandler 

func NewAuthenticatedServiceHandler(baseURL string, authToken string, authHeader string, httpClient *http.Client, scheme string) *ServiceHandler

NewAuthenticatedServiceHandler returns a new ServiceHandler that authenticates at the api via the provided token and sends all requests directly to the configuration-service

func NewServiceHandler 

func NewServiceHandler(baseURL string) *ServiceHandler

NewServiceHandler returns a new ServiceHandler which sends all requests directly to the configuration-service

func (*ServiceHandler) CreateServiceInStage added in v0.6.2 

func (s *ServiceHandler) CreateServiceInStage(project string, stage string, serviceName string) (*models.EventContext, *models.Error)

CreateService creates a new service

func (*ServiceHandler) DeleteServiceFromStage added in v0.7.1 

func (s *ServiceHandler) DeleteServiceFromStage(project string, stage string, serviceName string) (*models.EventContext, *models.Error)

DeleteServiceFromStage godoc

func (*ServiceHandler) GetAllServices added in v0.6.2 

func (s *ServiceHandler) GetAllServices(project string, stage string) ([]*models.Service, error)

GetAllServices returns a list of all services.

func (*ServiceHandler) GetService added in v0.7.0 

func (s *ServiceHandler) GetService(project, stage, service string) (*models.Service, error)

type StageHandler added in v0.6.2 

type StageHandler struct {
	BaseURL    string
	AuthToken  string
	AuthHeader string
	HTTPClient *http.Client
	Scheme     string
}

StageHandler handles stages

func NewAuthenticatedStageHandler added in v0.6.2 

func NewAuthenticatedStageHandler(baseURL string, authToken string, authHeader string, httpClient *http.Client, scheme string) *StageHandler

NewAuthenticatedStageHandler returns a new StageHandler that authenticates at the api via the provided token and sends all requests directly to the configuration-service

func NewStageHandler added in v0.6.2 

func NewStageHandler(baseURL string) *StageHandler

NewStageHandler returns a new StageHandler which sends all requests directly to the configuration-service

func (*StageHandler) CreateStage added in v0.6.2 

func (s *StageHandler) CreateStage(project string, stageName string) (*models.EventContext, *models.Error)

CreateStage creates a new stage with the provided name

func (*StageHandler) GetAllStages added in v0.6.2 

func (s *StageHandler) GetAllStages(project string) ([]*models.Stage, error)

GetAllStages returns a list of all stages.

type StatusBody added in v0.7.0 

type StatusBody struct {
	Status string `json:"status"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.