Keptn go-utils

Keptn V1 has reached end of life on December 22nd, 2023 and has been replaced.

This repository contains packages for common functionality around the Keptn Project. Please post any issues to keptn/keptn repository and label them with area:go-utils.

Installation

Get the latest version using

go get github.com/keptn/go-utils

Also consider browsing our Releases Page to find out about all releases.

Contributing

If you want to contribute, just create a PR on the master branch. Please also see CONTRIBUTING.md instructions on how to contribute.

Creating a Keptn service using cp-connector

One way to create a Keptn integration (a.k.a. Keptn service) is to use the cp-connector library which abstracts away the details of how to interact with the Keptn API to register your implementation as an integration to the control plane.

Example

Creating a Keptn service using the go-sdk (experimental)

If you want to use more features besides what the cp-connector provides, you can use the Keptn go-sdk which basically wraps around cp-connector and provides features like automatic sending of .started/.finished or error events.

Example

Accessing the Keptn API

The recommended way of accessing the Keptn API using GO is to use the APISet: You can use it by importing the following package:

import api "github.com/keptn/go-utils/pkg/api/utils/v2"

Then you need to create an APISet and provide it the information about the Keptn API endpoint URL and the auth token:

keptnAPI, err := api.New("https://url-to-my-keptn-cluster/api", api.WithAuthToken(mySecretToken))
if err != nil {
log.Fatal(err)
}

Once you have a handle to the APISet you can start using it:

resources, err := keptnAPI.Resources().GetAllServiceResources(context.TODO(), "my-project", "my-stage", "my-service", api.ResourcesGetAllServiceResourcesOptions{})
if err != nil {
log.Fatal(err)
}

Accessing the Keptn API from within the control plane

If you are developing a Keptn integration that is supposed to run inside/as part of the Keptn control plane, there is no need to talk to the Keptn API via the API gateway. In this case one option is to use the InternalAPISet.

Import the following package:

import api "github.com/keptn/go-utils/pkg/api/utils/v2"

Then create an InternalAPISet. Note, that this does not require you to pass the URL to the keptn API or an API token

keptnAPI, err := api.NewInternal(nil)
if err != nil {
log.Fatal(err)
}

Creating and inspecting Keptn events:

// Creating a new event
newEvent, _ := lib.KeptnEvent(lib.GetStartedEventType("echo-task"), "my-service", lib.EventData{
Project: "my-project",
Stage:   "my-stage",
Service: "my-service",
}).Build()

// Converting KeptnContextExtendedCE to cloudevents SDK event
cloudEvent := lib.ToCloudEvent(newEvent)
fmt.Println(cloudEvent.ID())

// Converting cloudevents SDK event to KeptnContextExtendedCE
newEvent, _ = lib.ToKeptnEvent(cloudEvent)

// Marshalling a keptn event to JSON
newEventAsJSON, _ := newEvent.ToJSON()
fmt.Println(string(newEventAsJSON))

// Creating a started event for a triggered event
startedEventType, _ := lib.ReplaceEventTypeKind(*triggeredEvent.Type, "started")
startedEvent := lib.KeptnEvent(startedEventType, "my-service", triggeredEvent.Data)

startedEventAsJSON, _ := startedEvent.ToJSON()
fmt.Println(string(startedEventAsJSON))

// Checking for event types
fmt.Println(lib.IsSequenceEventType("sh.keptn.event.echo.triggered")) // false
fmt.Println(lib.IsSequenceEventType("sh.keptn.event.stage.echo.triggered")) // true
fmt.Println(lib.IsTaskEventType("sh.keptn.event.echo.triggered")) // true
fmt.Println(lib.IsTaskEventType("sh.keptn.event.stage.echo.triggered")) // false
fmt.Println(lib.IsTriggeredEventType("sh.keptn.event.echo.triggered")) // true

Querying Keptn events

Events can be retrieved from Keptn by using the event API of the APISet.

Note, that when providing an event filter, either Project or KeptnContext must be set.

// Creating the APISet
apiSet, _ := api.New("http://<keptn-url>/api", api.WithAuthToken("<api-token>"))

// Getting all events for a specific project
events, _ := apiSet.Events().GetEvents(context.TODO(), &api.EventFilter{Project: "echo-project"}, api.EventsGetEventsOptions{})

// Getting all event matching a specific keptn context
events, _ = apiSet.Events().GetEvents(context.TODO(), &api.EventFilter{KeptnContext: "7d4ca79a-6f38-4b88-9139-433342e350bf"}, api.EventsGetEventsOptions{})

// Getting all .triggered events that are "not yet processed" by a keptn integration for a specific project
events, _ = apiSet.ShipyardControl().GetOpenTriggeredEvents(context.TODO(), api.EventFilter{Project: "echo-project"}, api.ShipyardControlGetOpenTriggeredEventsOptions{})

Ingesting Keptn events

When using cp-connector or go-sdk there is a way predefined way to get a handle to the event sender for being able to send back events to Keptn (see examples). Below is an example of how to use the APISet directly to send an event to Keptn:

// Creating the APISet
apiSet, _ := api.New("http://<keptn-url>/api", api.WithAuthToken("<api-token>"))

// Create event you want to send
eventToSend, _ := lib.KeptnEvent(lib.GetStartedEventType("echo-task"), "my-service",
	lib.EventData{
	    Project: "my-project", 
		Stage: "my-stage", 
		Service: "my-service",
	}).Build()

// Sending the event to Keptn
eventContext, _ := apiSet.API().SendEvent(context.TODO(), eventToSend, api.APISendEventOptions{})
fmt.Println(*eventContext.KeptnContext)

Keptn GO models / structs

The GO models for the Keptn API can be used by importing: github.com/keptn/go-utils/pkg/api/models.

Further, the GO models for e.g. the shipyard yaml etc. can be used by importing: github.com/keptn/go-utils/pkg/lib/v0_2_0