core

Documentation

Overview

package core contains a high level client for interacting with knative primitives used to realise, amongst other things, riff functions. The client typically returns structs for kubernetes resources, as they would have been written "by hand" to be applied by kubectl. It is not the role of the client to deal with printing, formatting or command line parsing.

Index

• func ParseEnvVar(envVars []string) ([]v1.EnvVar, error)
• func ParseEnvVarSource(envVarsFrom []string) ([]v1.EnvVar, error)
• type Builder
• type Client
  • func NewClient(clientConfig clientcmd.ClientConfig, kubeClient kubernetes.Interface, ...) Client
• type CreateChannelOptions
• type CreateFunctionOptions
• type CreateOrUpdateServiceOptions
• type CreateSubscriptionOptions
• type DeleteChannelOptions
• type DeleteServiceOptions
• type DeleteSubscriptionOptions
• type KubectlClient
  • func NewKubectlClient(kubeClient kubernetes.Interface) KubectlClient
• type ListChannelOptions
• type ListServiceOptions
• type ListSubscriptionsOptions
• type Manifest
  • func NewManifest(path string) (*Manifest, error)
  • func ResolveManifest(manifests map[string]*Manifest, path string) (*Manifest, error)
  • func (m *Manifest) VisitResources(f func(resource string) error) error
• type NamespaceInitOptions
• type ServiceInvokeOptions
• type ServiceStatusOptions
• type SystemInstallOptions
• type SystemUninstallOptions
• type UpdateFunctionOptions
• type Writer
  • func NewWriter(out io.Writer) Writer

Functions

func ParseEnvVar

func ParseEnvVar(envVars []string) ([]v1.EnvVar, error)

func ParseEnvVarSource

func ParseEnvVarSource(envVarsFrom []string) ([]v1.EnvVar, error)

Types

type Builder

type Builder interface {
	Build(appDir, buildImage, runImage, repoName string) error
}

type Client

type Client interface {
	CreateFunction(options CreateFunctionOptions, log io.Writer) (*serving.Service, error)
	UpdateFunction(options UpdateFunctionOptions, log io.Writer) error

	CreateSubscription(options CreateSubscriptionOptions) (*eventing.Subscription, error)
	DeleteSubscription(options DeleteSubscriptionOptions) error
	ListSubscriptions(options ListSubscriptionsOptions) (*eventing.SubscriptionList, error)

	ListChannels(options ListChannelOptions) (*eventing.ChannelList, error)
	CreateChannel(options CreateChannelOptions) (*eventing.Channel, error)
	DeleteChannel(options DeleteChannelOptions) error

	ListServices(options ListServiceOptions) (*serving.ServiceList, error)
	CreateService(options CreateOrUpdateServiceOptions) (*serving.Service, error)
	UpdateService(options CreateOrUpdateServiceOptions) (*serving.Service, error)
	DeleteService(options DeleteServiceOptions) error
	ServiceStatus(options ServiceStatusOptions) (*v1alpha1.ServiceCondition, error)
	ServiceCoordinates(options ServiceInvokeOptions) (ingressIP string, hostName string, err error)
}

func NewClient

func NewClient(clientConfig clientcmd.ClientConfig, kubeClient kubernetes.Interface, eventing eventing_cs.Interface, serving serving_cs.Interface, builder Builder) Client

type CreateChannelOptions

type CreateChannelOptions struct {
	Namespace  string
	Name       string
	Bus        string
	ClusterBus string
	DryRun     bool
}

type CreateFunctionOptions

type CreateFunctionOptions struct {
	CreateOrUpdateServiceOptions

	LocalPath   string
	GitRepo     string
	GitRevision string

	Invoker        string
	BuildpackImage string
	RunImage       string

	Handler  string
	Artifact string
}

type CreateOrUpdateServiceOptions

type CreateOrUpdateServiceOptions struct {
	Namespace string
	Name      string
	Image     string
	Env       []string
	EnvFrom   []string
	DryRun    bool
	Verbose   bool
	Wait      bool
}

type CreateSubscriptionOptions

type CreateSubscriptionOptions struct {
	Namespace  string
	Name       string
	Channel    string
	Subscriber string
	ReplyTo    string
	DryRun     bool
}

type DeleteChannelOptions

type DeleteChannelOptions struct {
	Namespace string
	Name      string
}

type DeleteServiceOptions

type DeleteServiceOptions struct {
	Namespace string
	Name      string
}

type DeleteSubscriptionOptions

type DeleteSubscriptionOptions struct {
	Namespace string
	Name      string
}

type KubectlClient

type KubectlClient interface {
	SystemInstall(manifests map[string]*Manifest, options SystemInstallOptions) (bool, error)
	SystemUninstall(options SystemUninstallOptions) (bool, error)
	NamespaceInit(manifests map[string]*Manifest, options NamespaceInitOptions) error
}

func NewKubectlClient

func NewKubectlClient(kubeClient kubernetes.Interface) KubectlClient

type ListChannelOptions

type ListChannelOptions struct {
	Namespace string
}

type ListServiceOptions

type ListServiceOptions struct {
	Namespace string
}

type ListSubscriptionsOptions

type ListSubscriptionsOptions struct {
	Namespace string
}

type Manifest

type Manifest struct {
	ManifestVersion string   `json:"manifestVersion"`
	Istio           []string `json:"istio"`
	Knative         []string `json:"knative"`
	Namespace       []string `json:"namespace"`
}

Manifest defines the location of YAML files for system components.

func NewManifest

func NewManifest(path string) (*Manifest, error)

func ResolveManifest

func ResolveManifest(manifests map[string]*Manifest, path string) (*Manifest, error)

func (*Manifest) VisitResources

func (m *Manifest) VisitResources(f func(resource string) error) error

type NamespaceInitOptions

type NamespaceInitOptions struct {
	NamespaceName string
	Manifest      string

	NoSecret          bool
	SecretName        string
	GcrTokenPath      string
	DockerHubUsername string
}

type ServiceInvokeOptions

type ServiceInvokeOptions struct {
	Namespace       string
	Name            string
	ContentTypeText bool
	ContentTypeJson bool
}

type ServiceStatusOptions

type ServiceStatusOptions struct {
	Namespace string
	Name      string
}

type SystemInstallOptions

type SystemInstallOptions struct {
	Manifest string
	NodePort bool
	Force    bool
}

type SystemUninstallOptions

type SystemUninstallOptions struct {
	Istio bool
	Force bool
}

type UpdateFunctionOptions

type UpdateFunctionOptions struct {
	Namespace string
	Name      string
	LocalPath string
	Verbose   bool
	Wait      bool
}

type Writer

type Writer interface {
	Print(event kail.Event) error
	Fprint(w io.Writer, event kail.Event) error
}

func NewWriter

func NewWriter(out io.Writer) Writer