mmesh

Documentation

Overview

Copyright 2021 IBM Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 IBM Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 IBM Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 IBM Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2021 IBM Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func CreateEtcdClient(etcdConfig EtcdConfig, secretData map[string][]byte, logger logr.Logger) (*etcd3.Client, error)
• type EtcdConfig
• type EtcdRangeWatcher
  • func NewEtcdRangeWatcher(logger logr.Logger, etcd *etcd3.Client, prefix string) *EtcdRangeWatcher
  • func (r *EtcdRangeWatcher) Start(ctx context.Context, keysOnly bool, listener KvListener)
• type EtcdSecret
  • func (es EtcdSecret) Apply(ctx context.Context, cl client.Client) error
• type KeyEvent
• type KeyEventChan
• type KeyEventType
  • func (t KeyEventType) String() string
• type KubeResolver
  • func InitGrpcResolver(defaultNamespace string, mgr ctrl.Manager) (*KubeResolver, error)
  • func (kr *KubeResolver) Build(target resolver.Target, cc resolver.ClientConn, _ resolver.BuildOptions) (resolver.Resolver, error)
  • func (kr *KubeResolver) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)
  • func (*KubeResolver) Scheme() string
• type KvListener
• type MMService
  • func NewMMService(namespace string, tlsConfig TLSConfigLookup) *MMService
  • func (mms *MMService) ConnectIfNeeded(ctx context.Context) error
  • func (mms *MMService) Disconnect()
  • func (mms *MMService) GetNameAndSpec() (string, *v1.ServiceSpec)
  • func (mms *MMService) InferenceEndpoints() (grpc, rest string)
  • func (mms *MMService) MMClient() mmeshapi.ModelMeshClient
  • func (mms *MMService) UpdateConfig(cp *config.ConfigProvider) (*config.Config, bool)
• type ModelMeshEventStream
  • func NewModelEventStream(logger logr.Logger, k8sClient k8sClient.Client, namespace string) (this *ModelMeshEventStream, err error)
  • func (mes *ModelMeshEventStream) RemoveWatchedService(serviceName, namespace string)
  • func (mes *ModelMeshEventStream) UpdateWatchedService(ctx context.Context, etcdSecretName, serviceName, namespace string) error
• type TLSConfigLookup

Constants

const (
	ModelRegistryPrefix  = "registry"
	VModelRegistryPrefix = "vmodels"
)

const KUBE_SCHEME = "kube"

Functions

func CreateEtcdClient

func CreateEtcdClient(etcdConfig EtcdConfig, secretData map[string][]byte, logger logr.Logger) (*etcd3.Client, error)

Types

type EtcdConfig

type EtcdConfig struct {
	Endpoints             string `json:"endpoints"`
	Username              string `json:"userid,omitempty"`
	Password              string `json:"password,omitempty"`
	RootPrefix            string `json:"root_prefix,omitempty"`
	Certificate           string `json:"certificate,omitempty"`
	CertificateFile       string `json:"certificate_file,omitempty"`
	ClientKey             string `json:"client_key,omitempty"`
	ClientKeyFile         string `json:"client_key_file,omitempty"`
	ClientCertificate     string `json:"client_certificate,omitempty"`
	ClientCertificateFile string `json:"client_certificate_file,omitempty"`
	OverrideAuthority     string `json:"override_authority,omitempty"`
}

type EtcdRangeWatcher

type EtcdRangeWatcher struct {
	WatchPrefix string
	// contains filtered or unexported fields
}

EtcdRangeWatcher A wrapper for Etcd Watch with common refresh Watch Channel logic

func NewEtcdRangeWatcher

func NewEtcdRangeWatcher(logger logr.Logger, etcd *etcd3.Client, prefix string) *EtcdRangeWatcher

func (*EtcdRangeWatcher) Start

func (r *EtcdRangeWatcher) Start(ctx context.Context, keysOnly bool, listener KvListener)

type EtcdSecret

type EtcdSecret struct {
	Log                 logr.Logger
	Name                string
	Namespace           string
	ControllerNamespace string
	EtcdConfig          *EtcdConfig
	Scheme              *runtime.Scheme
}

An EtcdSecret represents the etcd configuation for a user namespace

func (EtcdSecret) Apply

func (es EtcdSecret) Apply(ctx context.Context, cl client.Client) error

type KeyEvent

type KeyEvent struct {
	Key   string
	Value []byte
	Type  KeyEventType
}

type KeyEventChan

type KeyEventChan chan KeyEvent

type KeyEventType

type KeyEventType uint8

const (
	UPDATE KeyEventType = iota
	DELETE
	INITIALIZED
)

func (KeyEventType) String

func (t KeyEventType) String() string

type KubeResolver

type KubeResolver struct {
	client.Client
	// contains filtered or unexported fields
}

KubeResolver is a ResolverBuilder and a Reconciler

func InitGrpcResolver

func InitGrpcResolver(defaultNamespace string, mgr ctrl.Manager) (*KubeResolver, error)

InitGrpcResolver should only be called once

func (*KubeResolver) Build

func (kr *KubeResolver) Build(target resolver.Target, cc resolver.ClientConn,
	_ resolver.BuildOptions) (resolver.Resolver, error)

func (*KubeResolver) Reconcile

func (kr *KubeResolver) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error)

func (*KubeResolver) Scheme

func (*KubeResolver) Scheme() string

type KvListener

type KvListener func(eventType KeyEventType, key string, value []byte)

type MMService

type MMService struct {
	// these don't change
	Log logr.Logger
	// contains filtered or unexported fields
}

Encapsulates ModelMesh gRPC service

func NewMMService

func NewMMService(namespace string, tlsConfig TLSConfigLookup) *MMService

func (*MMService) ConnectIfNeeded

func (mms *MMService) ConnectIfNeeded(ctx context.Context) error

ConnectIfNeeded is called only in service reconcile

func (*MMService) Disconnect

func (mms *MMService) Disconnect()

Disconnect is called only in service reconcile

func (*MMService) GetNameAndSpec

func (mms *MMService) GetNameAndSpec() (string, *v1.ServiceSpec)

func (*MMService) InferenceEndpoints

func (mms *MMService) InferenceEndpoints() (grpc, rest string)

func (*MMService) MMClient

func (mms *MMService) MMClient() mmeshapi.ModelMeshClient

MMClient is called from predictor controller

func (*MMService) UpdateConfig

func (mms *MMService) UpdateConfig(cp *config.ConfigProvider) (*config.Config, bool)

type ModelMeshEventStream

type ModelMeshEventStream struct {
	MMEvents chan event.GenericEvent
	// contains filtered or unexported fields
}

ModelMeshEventStream generates events for Predictors based on changes to models/vmodels within model-mesh's etcd-based registries. This is unfortunately tightly coupled to certain model-mesh internal details (i.e. etcd layout), and in future we would like to expose streaming gRPC APIs from model-mesh for an "official" way to watch for model events.

func NewModelEventStream

func NewModelEventStream(logger logr.Logger, k8sClient k8sClient.Client,
	namespace string) (this *ModelMeshEventStream, err error)

func (*ModelMeshEventStream) RemoveWatchedService

func (mes *ModelMeshEventStream) RemoveWatchedService(serviceName, namespace string)

RemoveWatchedService is called from service reconciler

func (*ModelMeshEventStream) UpdateWatchedService

func (mes *ModelMeshEventStream) UpdateWatchedService(ctx context.Context,
	etcdSecretName, serviceName, namespace string) error

UpdateWatchedService is called from service reconciler

type TLSConfigLookup

type TLSConfigLookup func(context.Context, string) (*tls.Config, error)