kong

Documentation

Index

• type ACLConfig
• type DoRequest
• type DocumentObject
• type DocumentObjects
• type KongAPIClient
• type KongClient
  • func NewKongClient(baseClient *http.Client, kongConfig *config.KongGatewayConfig) (*KongClient, error)
  • func (k KongClient) AddConsumerACL(ctx context.Context, id string) error
  • func (k KongClient) AddQuota(ctx context.Context, routeID, managedAppID, quotaInterval string, ...) error
  • func (k KongClient) AddRouteACL(ctx context.Context, routeID, allowedID string) error
  • func (k KongClient) CreateAuthKey(ctx context.Context, consumerID string, keyAuth *klib.KeyAuth) (*klib.KeyAuth, error)
  • func (k KongClient) CreateConsumer(ctx context.Context, id, name string) (*klib.Consumer, error)
  • func (k KongClient) CreateHttpBasic(ctx context.Context, consumerID string, basicAuth *klib.BasicAuth) (*klib.BasicAuth, error)
  • func (k KongClient) CreateOauth2(ctx context.Context, consumerID string, oauth2 *klib.Oauth2Credential) (*klib.Oauth2Credential, error)
  • func (k KongClient) DeleteAuthKey(ctx context.Context, consumerID, authKey string) error
  • func (k KongClient) DeleteConsumer(ctx context.Context, id string) error
  • func (k KongClient) DeleteHttpBasic(ctx context.Context, consumerID, username string) error
  • func (k KongClient) DeleteOauth2(ctx context.Context, consumerID, clientID string) error
  • func (k KongClient) GetKongPlugins() *Plugins
  • func (k KongClient) GetSpecForService(ctx context.Context, service *klib.Service) ([]byte, error)
  • func (k KongClient) ListRoutesForService(ctx context.Context, serviceId string) ([]*klib.Route, error)
  • func (k KongClient) ListServices(ctx context.Context) ([]*klib.Service, error)
  • func (k KongClient) RemoveRouteACL(ctx context.Context, routeID, revokedID string) error
• type KongServiceSpec
• type PluginLister
• type Plugins
  • func (p *Plugins) GetEffectivePlugins(routeID, serviceID string) (map[string]*klib.Plugin, error)

Types

type ACLConfig

type ACLConfig struct {
	AllowedGroups    []string `json:"allow,omitempty" yaml:"allow,omitempty"`
	DeniedGroups     []string `json:"deny,omitempty" yaml:"deny,omitempty"`
	HideGroupsHeader bool     `json:"hide_groups_header" yaml:"hide_groups_header"`
}

type DoRequest

type DoRequest interface {
	Do(req *http.Request) (*http.Response, error)
}

type DocumentObject

type DocumentObject struct {
	CreatedAt int    `json:"created_at,omitempty"`
	ID        string `json:"id,omitempty"`
	Path      string `json:"path,omitempty"`
	Service   struct {
		ID string `json:"id,omitempty"`
	} `json:"service,omitempty"`
}

type DocumentObjects

type DocumentObjects struct {
	Data []DocumentObject `json:"data,omitempty"`
	Next string           `json:"next,omitempty"`
}

type KongAPIClient

type KongAPIClient interface {
	// Provisioning
	CreateConsumer(ctx context.Context, id, name string) (*klib.Consumer, error)
	AddConsumerACL(ctx context.Context, id string) error
	DeleteConsumer(ctx context.Context, id string) error
	// Credential
	DeleteOauth2(ctx context.Context, consumerID, clientID string) error
	DeleteHttpBasic(ctx context.Context, consumerID, username string) error
	DeleteAuthKey(ctx context.Context, consumerID, authKey string) error
	CreateHttpBasic(ctx context.Context, consumerID string, basicAuth *klib.BasicAuth) (*klib.BasicAuth, error)
	CreateOauth2(ctx context.Context, consumerID string, oauth2 *klib.Oauth2Credential) (*klib.Oauth2Credential, error)
	CreateAuthKey(ctx context.Context, consumerID string, keyAuth *klib.KeyAuth) (*klib.KeyAuth, error)
	// Access Request
	AddRouteACL(ctx context.Context, routeID, allowedID string) error
	RemoveRouteACL(ctx context.Context, routeID, revokedID string) error
	AddQuota(ctx context.Context, routeID, allowedID, quotaInterval string, quotaLimit int) error

	ListServices(ctx context.Context) ([]*klib.Service, error)
	ListRoutesForService(ctx context.Context, serviceId string) ([]*klib.Route, error)
	GetSpecForService(ctx context.Context, service *klib.Service) ([]byte, error)
	GetKongPlugins() *Plugins
}

type KongClient

type KongClient struct {
	*klib.Client
	// contains filtered or unexported fields
}

func NewKongClient

func NewKongClient(baseClient *http.Client, kongConfig *config.KongGatewayConfig) (*KongClient, error)

func (KongClient) AddConsumerACL

func (k KongClient) AddConsumerACL(ctx context.Context, id string) error

func (KongClient) AddQuota

func (k KongClient) AddQuota(ctx context.Context, routeID, managedAppID, quotaInterval string, quotaLimit int) error

func (KongClient) AddRouteACL

func (k KongClient) AddRouteACL(ctx context.Context, routeID, allowedID string) error

func (KongClient) CreateAuthKey

func (k KongClient) CreateAuthKey(ctx context.Context, consumerID string, keyAuth *klib.KeyAuth) (*klib.KeyAuth, error)

func (KongClient) CreateConsumer

func (k KongClient) CreateConsumer(ctx context.Context, id, name string) (*klib.Consumer, error)

func (KongClient) CreateHttpBasic

func (k KongClient) CreateHttpBasic(ctx context.Context, consumerID string, basicAuth *klib.BasicAuth) (*klib.BasicAuth, error)

func (KongClient) CreateOauth2

func (k KongClient) CreateOauth2(ctx context.Context, consumerID string, oauth2 *klib.Oauth2Credential) (*klib.Oauth2Credential, error)

func (KongClient) DeleteAuthKey

func (k KongClient) DeleteAuthKey(ctx context.Context, consumerID, authKey string) error

func (KongClient) DeleteConsumer

func (k KongClient) DeleteConsumer(ctx context.Context, id string) error

func (KongClient) DeleteHttpBasic

func (k KongClient) DeleteHttpBasic(ctx context.Context, consumerID, username string) error

func (KongClient) DeleteOauth2

func (k KongClient) DeleteOauth2(ctx context.Context, consumerID, clientID string) error

func (KongClient) GetKongPlugins

func (k KongClient) GetKongPlugins() *Plugins

func (KongClient) GetSpecForService

func (k KongClient) GetSpecForService(ctx context.Context, service *klib.Service) ([]byte, error)

func (KongClient) ListRoutesForService

func (k KongClient) ListRoutesForService(ctx context.Context, serviceId string) ([]*klib.Route, error)

func (KongClient) ListServices

func (k KongClient) ListServices(ctx context.Context) ([]*klib.Service, error)

func (KongClient) RemoveRouteACL

func (k KongClient) RemoveRouteACL(ctx context.Context, routeID, revokedID string) error

type KongServiceSpec

type KongServiceSpec struct {
	Contents  string `json:"contents"`
	CreatedAt int    `json:"created_at"`
	ID        string `json:"id"`
	Path      string `json:"path"`
	Checksum  string `json:"checksum"`
}

type PluginLister

type PluginLister interface {
	ListAll(ctx context.Context) ([]*klib.Plugin, error)
}

type Plugins

type Plugins struct {
	PluginLister
}

func (*Plugins) GetEffectivePlugins

func (p *Plugins) GetEffectivePlugins(routeID, serviceID string) (map[string]*klib.Plugin, error)

GetEffectivePlugins determines the effective plugin configuration for the route/service combination. Returns a map containing effective Plugin configuration grouped by plugin type.