connector

Documentation

Index

• type KymaConnector
  • func New(srv *server.Server, prefix string) *KymaConnector
  • func (kc *KymaConnector) SendCSRResponse(ctx context.Context, responseURL, subject string) (string, error)
• type RegisterResponse
• type Service
• type ServiceAPI
• type ServiceBasicCredentials
• type ServiceCredentials
• type ServiceDocumentation
• type ServiceDocumentationDoc
• type ServiceEvent
• type ServiceLabel
• type ServiceOAuthCredentials

Types

type KymaConnector

type KymaConnector struct {
	Serving   *server.Server
	AppInfo   *certificate.ApplicationConnectResponse
	AppConfig config.Config
	// contains filtered or unexported fields
}

KymaConnector holds all information and functionality regarding Kyma

func New

func New(srv *server.Server, prefix string) *KymaConnector

New Kyma one time init factory.

func (*KymaConnector) SendCSRResponse

func (kc *KymaConnector) SendCSRResponse(ctx context.Context, responseURL, subject string) (string, error)

SendCSRResponse sends a POST request with a newly generated certificate signing request response to the passed URL.

type RegisterResponse

type RegisterResponse struct {
	ID string `json:"id"`
}

RegisterResponse is the response received from registering a service.

type Service

type Service struct {
	Provider         string                `json:"provider,omitempty"`
	Name             string                `json:"name,omitempty"`
	Description      string                `json:"description,omitempty"`
	ShortDescription string                `json:"shortDescription,omitempty"`
	Labels           *ServiceLabel         `json:"labels,omitempty"`
	API              *ServiceAPI           `json:"api,omitempty"`
	Events           *ServiceEvent         `json:"events,omitempty"`
	Documentation    *ServiceDocumentation `json:"documentation,omitempty"`
}

Service kyma service struct

type ServiceAPI

type ServiceAPI struct {
	TargetURL   string              `json:"targetUrl,omitempty"`
	Spec        json.RawMessage     `json:"spec,omitempty"`
	Credentials *ServiceCredentials `json:"credentials,omitempty"`
}

ServiceAPI kyma service api definition

type ServiceBasicCredentials

type ServiceBasicCredentials struct {
	ClientID string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
}

ServiceBasicCredentials kyma basic auth service credentials

type ServiceCredentials

type ServiceCredentials struct {
	Basic *ServiceBasicCredentials `json:"basic,omitempty"`
	OAuth *ServiceOAuthCredentials `json:"oauth,omitempty"`
}

ServiceCredentials kyma service credentials definition

type ServiceDocumentation

type ServiceDocumentation struct {
	DisplayName string                     `json:"displayName,omitempty"`
	Description string                     `json:"description,omitempty"`
	Type        string                     `json:"type,omitempty"`
	Tags        []string                   `json:"tags,omitempty"`
	Docs        []*ServiceDocumentationDoc `json:"docs,omitempty"`
}

ServiceDocumentation kyma service documentation definition

type ServiceDocumentationDoc

type ServiceDocumentationDoc struct {
	Title  string `json:"title,omitempty"`
	Type   string `json:"type,omitempty"`
	Source string `json:"source,omitempty"`
}

ServiceDocumentationDoc kyma service documentation doc definition

type ServiceEvent

type ServiceEvent struct {
	Spec json.RawMessage `json:"spec,omitempty"`
}

ServiceEvent kyma service event definition

type ServiceLabel

type ServiceLabel map[string]string

ServiceLabel kyma service labels

type ServiceOAuthCredentials

type ServiceOAuthCredentials struct {
	ClientID     string `json:"clientId,omitempty"`
	ClientSecret string `json:"clientSecret,omitempty"`
}

ServiceOAuthCredentials kyma oauth service credentials