Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type KnServingClient ¶
type KnServingClient interface {
// Namespace in which this client is operating for
Namespace() string
// Get a service by its unique name
GetService(ctx context.Context, name string) (*servingv1.Service, error)
// List services
ListServices(ctx context.Context, opts ...ListConfig) (*servingv1.ServiceList, error)
// Create a new service
CreateService(ctx context.Context, service *servingv1.Service) error
// UpdateService updates the given service. For a more robust variant with automatic
// conflict resolution see UpdateServiceWithRetry
UpdateService(ctx context.Context, service *servingv1.Service) (bool, error)
// UpdateServiceWithRetry updates service and retries if there is a version conflict.
// The updateFunc receives a deep copy of the existing service and can add update it in
// place. Return if the service creates a new generation or not
UpdateServiceWithRetry(ctx context.Context, name string, updateFunc ServiceUpdateFunc, nrRetries int) (bool, error)
// Apply a service's definition to the cluster. The full service declaration needs to be provided,
// which is different to UpdateService which can also do a partial update. If the given
// service does not already exists (identified by name) then the service is create.
// If the service exists, then a three-way merge will be performed between the original
// configuration given (from the last "apply" operation), the new configuration as given ]
// here and the current configuration as found on the cluster.
// The returned bool indicates whether the service has been changed or whether this operation
// was a no-op
// An error can indicate a general error or a conflict that occurred during the three way merge.
ApplyService(ctx context.Context, service *servingv1.Service) (bool, error)
// Delete a service by name
DeleteService(ctx context.Context, name string, timeout time.Duration) error
// Wait for a service to become ready, but not longer than provided timeout.
// Return error and how long has been waited
WaitForService(ctx context.Context, name string, wconfig WaitConfig, msgCallback wait.MessageCallback) (error, time.Duration)
// Get a configuration by name
GetConfiguration(ctx context.Context, name string) (*servingv1.Configuration, error)
// Get a revision by name
GetRevision(ctx context.Context, name string) (*servingv1.Revision, error)
// Get the "base" revision for a Service; the one that corresponds to the
// current template.
GetBaseRevision(ctx context.Context, service *servingv1.Service) (*servingv1.Revision, error)
// Create revision
CreateRevision(ctx context.Context, revision *servingv1.Revision) error
// Update revision
UpdateRevision(ctx context.Context, revision *servingv1.Revision) error
// List revisions
ListRevisions(ctx context.Context, opts ...ListConfig) (*servingv1.RevisionList, error)
// Delete a revision
DeleteRevision(ctx context.Context, name string, timeout time.Duration) error
// Get a route by its unique name
GetRoute(ctx context.Context, name string) (*servingv1.Route, error)
// List routes
ListRoutes(ctx context.Context, opts ...ListConfig) (*servingv1.RouteList, error)
}
Kn interface to serving. All methods are relative to the namespace specified during construction
func NewKnServingClient ¶
func NewKnServingClient(client clientv1.ServingV1Interface, namespace string) KnServingClient
Create a new client facade for the provided namespace
func NewKnServingGitOpsClient ¶
func NewKnServingGitOpsClient(namespace, dir string) KnServingClient
NewKnServingGitOpsClient returns an instance of the kn service gitops client
type ListConfig ¶
type ListConfig func(config *listConfigCollector)
Config function for builder pattern
func WithLabel ¶
func WithLabel(labelKey, labelValue string) ListConfig
WithLabel filters on the provided label
type ListConfigs ¶
type ListConfigs []ListConfig
type NoBaseRevisionError ¶
type NoBaseRevisionError struct {
// contains filtered or unexported fields
}
func (NoBaseRevisionError) Error ¶
func (e NoBaseRevisionError) Error() string
type ServiceUpdateFunc ¶
Func signature for an updating function which returns the updated service object or an error
Click to show internal directories.
Click to hide internal directories.