Files
virtual-kubelet/vendor/github.com/vmware/vic/lib/tether/interfaces.go
Loc Nguyen 513cebe7b7 VMware vSphere Integrated Containers provider (#206)
* Add Virtual Kubelet provider for VIC

Initial virtual kubelet provider for VMware VIC.  This provider currently
handles creating and starting of a pod VM via the VIC portlayer and persona
server.  Image store handling via the VIC persona server.  This provider
currently requires the feature/wolfpack branch of VIC.

* Added pod stop and delete.  Also added node capacity.

Added the ability to stop and delete pod VMs via VIC.  Also retrieve
node capacity information from the VCH.

* Cleanup and readme file

Some file clean up and added a Readme.md markdown file for the VIC
provider.

* Cleaned up errors, added function comments, moved operation code

1. Cleaned up error handling.  Set standard for creating errors.
2. Added method prototype comments for all interface functions.
3. Moved PodCreator, PodStarter, PodStopper, and PodDeleter to a new folder.

* Add mocking code and unit tests for podcache, podcreator, and podstarter

Used the unit test framework used in VIC to handle assertions in the provider's
unit test.  Mocking code generated using OSS project mockery, which is compatible
with the testify assertion framework.

* Vendored packages for the VIC provider

Requires feature/wolfpack branch of VIC and a few specific commit sha of
projects used within VIC.

* Implementation of POD Stopper and Deleter unit tests (#4)

* Updated files for initial PR
2018-06-04 15:41:32 -07:00

79 lines
2.8 KiB
Go

// Copyright 2016-2017 VMware, Inc. All Rights Reserved.
//
// 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.
package tether
import (
"context"
"io"
"net/url"
"os"
"github.com/vmware/vic/pkg/dio"
)
// UtilityFn is the sigature of a function that can be used to launch a utility process
type UtilityFn func() (*os.Process, error)
// Operations defines the set of operations that Tether depends upon. These are split out for:
// * portability
// * dependency injection (primarily for testing)
// * behavioural control (e.g. what behaviour is required when a session exits)
type Operations interface {
Setup(Config) error
Cleanup() error
// Log returns the tether debug log writer
Log() (io.Writer, error)
SetHostname(hostname string, aliases ...string) error
SetupFirewall(ctx context.Context, config *ExecutorConfig) error
Apply(endpoint *NetworkEndpoint) error
MountLabel(ctx context.Context, label, target string) error
MountTarget(ctx context.Context, source url.URL, target string, mountOptions string) error
CopyExistingContent(source string) error
Fork() error
// Returns two DynamicMultiWriters for stdout and stderr
SessionLog(session *SessionConfig) (dio.DynamicMultiWriter, dio.DynamicMultiWriter, error)
// Returns a function to invoke after the session state has been persisted
HandleSessionExit(config *ExecutorConfig, session *SessionConfig) func()
ProcessEnv(env []string) []string
// LaunchUtility starts a process and provides a way to block on completion and retrieve
// it's exit code. This is needed to co-exist with a childreaper.
LaunchUtility(UtilityFn) (<-chan int, error)
// HandleUtilityExit will process the utility exit. If the pid cannot be matched to a launched
// utility process then this returns false and does nothing.
HandleUtilityExit(pid, exitCode int) bool
}
// Tether presents the consumption interface for code needing to run a tether
type Tether interface {
Start() error
Stop() error
Reload()
Register(name string, ext Extension)
}
// Extension is a very simple extension interface for supporting code that need to be
// notified when the configuration is reloaded.
type Extension interface {
Start() error
Reload(config *ExecutorConfig) error
Stop() error
}
type Config interface {
UpdateNetworkEndpoint(e *NetworkEndpoint) error
Flush() error
}