v1alpha

package
v1.28.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 27, 2017 License: Apache-2.0 Imports: 5 Imported by: 300

README

WARNING

The API defined here is proposed, experimental, and (for now) subject to change at any time.

If you think you want to use it, or for any other queries, contact rkt-dev@googlegroups.com or file an issue

For more information, see:

Protobuf

The rkt gRPC API uses Protocol Buffers for its services. In order to rebuild the generated code make sure you have protobuf 3.0.0 installed (https://github.com/google/protobuf) and execute from the top-level directory:

$ make protobuf

Documentation

Overview

Package v1alpha is a generated protocol buffer package.

It is generated from these files: 

api.proto

It has these top-level messages: 

ImageFormat
Image
Network
App
Pod
KeyValue
PodFilter
ImageFilter
GlobalFlags
Info
Event
EventFilter
GetInfoRequest
GetInfoResponse
ListPodsRequest
ListPodsResponse
InspectPodRequest
InspectPodResponse
ListImagesRequest
ListImagesResponse
InspectImageRequest
InspectImageResponse
ListenEventsRequest
ListenEventsResponse
GetLogsRequest
GetLogsResponse

Index

Constants

This section is empty.

Variables

View Source 
var AppState_name = map[int32]string{
	0: "APP_STATE_UNDEFINED",
	1: "APP_STATE_RUNNING",
	2: "APP_STATE_EXITED",
}
View Source 
var AppState_value = map[string]int32{
	"APP_STATE_UNDEFINED": 0,
	"APP_STATE_RUNNING":   1,
	"APP_STATE_EXITED":    2,
}
View Source 
var EventType_name = map[int32]string{
	0: "EVENT_TYPE_UNDEFINED",
	1: "EVENT_TYPE_POD_PREPARED",
	2: "EVENT_TYPE_POD_PREPARE_ABORTED",
	3: "EVENT_TYPE_POD_STARTED",
	4: "EVENT_TYPE_POD_EXITED",
	5: "EVENT_TYPE_POD_GARBAGE_COLLECTED",
	6: "EVENT_TYPE_APP_STARTED",
	7: "EVENT_TYPE_APP_EXITED",
	8: "EVENT_TYPE_IMAGE_IMPORTED",
	9: "EVENT_TYPE_IMAGE_REMOVED",
}
View Source 
var EventType_value = map[string]int32{
	"EVENT_TYPE_UNDEFINED":             0,
	"EVENT_TYPE_POD_PREPARED":          1,
	"EVENT_TYPE_POD_PREPARE_ABORTED":   2,
	"EVENT_TYPE_POD_STARTED":           3,
	"EVENT_TYPE_POD_EXITED":            4,
	"EVENT_TYPE_POD_GARBAGE_COLLECTED": 5,
	"EVENT_TYPE_APP_STARTED":           6,
	"EVENT_TYPE_APP_EXITED":            7,
	"EVENT_TYPE_IMAGE_IMPORTED":        8,
	"EVENT_TYPE_IMAGE_REMOVED":         9,
}
View Source 
var ImageType_name = map[int32]string{
	0: "IMAGE_TYPE_UNDEFINED",
	1: "IMAGE_TYPE_APPC",
	2: "IMAGE_TYPE_DOCKER",
	3: "IMAGE_TYPE_OCI",
}
View Source 
var ImageType_value = map[string]int32{
	"IMAGE_TYPE_UNDEFINED": 0,
	"IMAGE_TYPE_APPC":      1,
	"IMAGE_TYPE_DOCKER":    2,
	"IMAGE_TYPE_OCI":       3,
}
View Source 
var PodState_name = map[int32]string{
	0: "POD_STATE_UNDEFINED",
	1: "POD_STATE_EMBRYO",
	2: "POD_STATE_PREPARING",
	3: "POD_STATE_PREPARED",
	4: "POD_STATE_RUNNING",
	5: "POD_STATE_ABORTED_PREPARE",
	6: "POD_STATE_EXITED",
	7: "POD_STATE_DELETING",
	8: "POD_STATE_GARBAGE",
}
View Source 
var PodState_value = map[string]int32{
	"POD_STATE_UNDEFINED":       0,
	"POD_STATE_EMBRYO":          1,
	"POD_STATE_PREPARING":       2,
	"POD_STATE_PREPARED":        3,
	"POD_STATE_RUNNING":         4,
	"POD_STATE_ABORTED_PREPARE": 5,
	"POD_STATE_EXITED":          6,
	"POD_STATE_DELETING":        7,
	"POD_STATE_GARBAGE":         8,
}

Functions

func RegisterPublicAPIServer 

func RegisterPublicAPIServer(s *grpc.Server, srv PublicAPIServer)

Types

type App 

type App struct {
	// Name of the app, required.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// Image used by the app, required. However, this may only contain the image id
	// if it is returned by ListPods().
	Image *Image `protobuf:"bytes,2,opt,name=image" json:"image,omitempty"`
	// State of the app. optional, non-empty only if it's returned by InspectPod().
	State AppState `protobuf:"varint,3,opt,name=state,enum=v1alpha.AppState" json:"state,omitempty"`
	// Exit code of the app. optional, only valid if it's returned by InspectPod() and
	// the app has already exited.
	ExitCode int32 `protobuf:"zigzag32,4,opt,name=exit_code,json=exitCode" json:"exit_code,omitempty"`
	// Annotations for this app.
	Annotations []*KeyValue `protobuf:"bytes,5,rep,name=annotations" json:"annotations,omitempty"`
}

App describes the information of an app that's running in a pod.

func (*App) Descriptor added in v0.16.0 

func (*App) Descriptor() ([]byte, []int)

func (*App) GetAnnotations added in v0.15.0 

func (m *App) GetAnnotations() []*KeyValue

func (*App) GetExitCode added in v1.25.0 

func (m *App) GetExitCode() int32

func (*App) GetImage 

func (m *App) GetImage() *Image

func (*App) GetName added in v1.25.0 

func (m *App) GetName() string

func (*App) GetState added in v1.25.0 

func (m *App) GetState() AppState

func (*App) ProtoMessage 

func (*App) ProtoMessage()

func (*App) Reset 

func (m *App) Reset()

func (*App) String 

func (m *App) String() string

type AppState 

type AppState int32

AppState defines the possible states of the app. 

const (
	AppState_APP_STATE_UNDEFINED AppState = 0
	AppState_APP_STATE_RUNNING   AppState = 1
	AppState_APP_STATE_EXITED    AppState = 2
)

func (AppState) EnumDescriptor added in v0.16.0 

func (AppState) EnumDescriptor() ([]byte, []int)

func (AppState) String 

func (x AppState) String() string

type Event 

type Event struct {
	// Type of the event, required.
	Type EventType `protobuf:"varint,1,opt,name=type,enum=v1alpha.EventType" json:"type,omitempty"`
	// ID of the subject that causes the event, required.
	// If the event is a pod or app event, the id is the pod's uuid.
	// If the event is an image event, the id is the image's id.
	Id string `protobuf:"bytes,2,opt,name=id" json:"id,omitempty"`
	// Name of the subject that causes the event, required.
	// If the event is a pod event, the name is the pod's name.
	// If the event is an app event, the name is the app's name.
	// If the event is an image event, the name is the image's name.
	From string `protobuf:"bytes,3,opt,name=from" json:"from,omitempty"`
	// Timestamp of when the event happens, it is the seconds since epoch, required.
	Time int64 `protobuf:"varint,4,opt,name=time" json:"time,omitempty"`
	// Data of the event, in the form of key-value pairs, optional.
	Data []*KeyValue `protobuf:"bytes,5,rep,name=data" json:"data,omitempty"`
}

Event describes the events that will be received via ListenEvents().

func (*Event) Descriptor added in v0.16.0 

func (*Event) Descriptor() ([]byte, []int)

func (*Event) GetData 

func (m *Event) GetData() []*KeyValue

func (*Event) GetFrom added in v1.25.0 

func (m *Event) GetFrom() string

func (*Event) GetId added in v1.25.0 

func (m *Event) GetId() string

func (*Event) GetTime added in v1.25.0 

func (m *Event) GetTime() int64

func (*Event) GetType added in v1.25.0 

func (m *Event) GetType() EventType

func (*Event) ProtoMessage 

func (*Event) ProtoMessage()

func (*Event) Reset 

func (m *Event) Reset()

func (*Event) String 

func (m *Event) String() string

type EventFilter 

type EventFilter struct {
	// If not empty, then only returns the events that have the listed types.
	Types []EventType `protobuf:"varint,1,rep,packed,name=types,enum=v1alpha.EventType" json:"types,omitempty"`
	// If not empty, then only returns the events whose 'id' is included in the listed ids.
	Ids []string `protobuf:"bytes,2,rep,name=ids" json:"ids,omitempty"`
	// If not empty, then only returns the events whose 'from' is included in the listed names.
	Names []string `protobuf:"bytes,3,rep,name=names" json:"names,omitempty"`
	// If set, then only returns the events after this timestamp.
	// If the server starts after since_time, then only the events happened after the start of the server will be returned.
	// If since_time is a future timestamp, then no events will be returned until that time.
	SinceTime int64 `protobuf:"varint,4,opt,name=since_time,json=sinceTime" json:"since_time,omitempty"`
	// If set, then only returns the events before this timestamp.
	// If it is a future timestamp, then the event stream will be closed at that moment.
	UntilTime int64 `protobuf:"varint,5,opt,name=until_time,json=untilTime" json:"until_time,omitempty"`
}

EventFilter defines the condition that the returned events needs to satisfy in ListImages(). The condition are combined by 'AND'.

func (*EventFilter) Descriptor added in v0.16.0 

func (*EventFilter) Descriptor() ([]byte, []int)

func (*EventFilter) GetIds added in v1.25.0 

func (m *EventFilter) GetIds() []string

func (*EventFilter) GetNames added in v1.25.0 

func (m *EventFilter) GetNames() []string

func (*EventFilter) GetSinceTime added in v1.25.0 

func (m *EventFilter) GetSinceTime() int64

func (*EventFilter) GetTypes added in v1.25.0 

func (m *EventFilter) GetTypes() []EventType

func (*EventFilter) GetUntilTime added in v1.25.0 

func (m *EventFilter) GetUntilTime() int64

func (*EventFilter) ProtoMessage 

func (*EventFilter) ProtoMessage()

func (*EventFilter) Reset 

func (m *EventFilter) Reset()

func (*EventFilter) String 

func (m *EventFilter) String() string

type EventType 

type EventType int32

EventType defines the type of the events that will be received via ListenEvents(). 

const (
	EventType_EVENT_TYPE_UNDEFINED EventType = 0
	// Pod events.
	EventType_EVENT_TYPE_POD_PREPARED          EventType = 1
	EventType_EVENT_TYPE_POD_PREPARE_ABORTED   EventType = 2
	EventType_EVENT_TYPE_POD_STARTED           EventType = 3
	EventType_EVENT_TYPE_POD_EXITED            EventType = 4
	EventType_EVENT_TYPE_POD_GARBAGE_COLLECTED EventType = 5
	// App events.
	EventType_EVENT_TYPE_APP_STARTED EventType = 6
	EventType_EVENT_TYPE_APP_EXITED  EventType = 7
	// Image events.
	EventType_EVENT_TYPE_IMAGE_IMPORTED EventType = 8
	EventType_EVENT_TYPE_IMAGE_REMOVED  EventType = 9
)

func (EventType) EnumDescriptor added in v0.16.0 

func (EventType) EnumDescriptor() ([]byte, []int)

func (EventType) String 

func (x EventType) String() string

type GetInfoRequest 

type GetInfoRequest struct {
}

Request for GetInfo().

func (*GetInfoRequest) Descriptor added in v0.16.0 

func (*GetInfoRequest) Descriptor() ([]byte, []int)

func (*GetInfoRequest) ProtoMessage 

func (*GetInfoRequest) ProtoMessage()

func (*GetInfoRequest) Reset 

func (m *GetInfoRequest) Reset()

func (*GetInfoRequest) String 

func (m *GetInfoRequest) String() string

type GetInfoResponse 

type GetInfoResponse struct {
	Info *Info `protobuf:"bytes,1,opt,name=info" json:"info,omitempty"`
}

Response for GetInfo().

func (*GetInfoResponse) Descriptor added in v0.16.0 

func (*GetInfoResponse) Descriptor() ([]byte, []int)

func (*GetInfoResponse) GetInfo 

func (m *GetInfoResponse) GetInfo() *Info

func (*GetInfoResponse) ProtoMessage 

func (*GetInfoResponse) ProtoMessage()

func (*GetInfoResponse) Reset 

func (m *GetInfoResponse) Reset()

func (*GetInfoResponse) String 

func (m *GetInfoResponse) String() string

type GetLogsRequest 

type GetLogsRequest struct {
	// ID of the pod which we will get logs from, required.
	PodId string `protobuf:"bytes,1,opt,name=pod_id,json=podId" json:"pod_id,omitempty"`
	// Name of the app within the pod which we will get logs
	// from, optional. If not set, then the logs of all the
	// apps within the pod will be returned.
	AppName string `protobuf:"bytes,2,opt,name=app_name,json=appName" json:"app_name,omitempty"`
	// Number of most recent lines to return, optional.
	Lines int32 `protobuf:"varint,3,opt,name=lines" json:"lines,omitempty"`
	// If true, then a response stream will not be closed,
	// and new log response will be sent via the stream, default is false.
	Follow bool `protobuf:"varint,4,opt,name=follow" json:"follow,omitempty"`
	// If set, then only the logs after the timestamp will
	// be returned, optional.
	SinceTime int64 `protobuf:"varint,5,opt,name=since_time,json=sinceTime" json:"since_time,omitempty"`
	// If set, then only the logs before the timestamp will
	// be returned, optional.
	UntilTime int64 `protobuf:"varint,6,opt,name=until_time,json=untilTime" json:"until_time,omitempty"`
}

Request for GetLogs().

func (*GetLogsRequest) Descriptor added in v0.16.0 

func (*GetLogsRequest) Descriptor() ([]byte, []int)

func (*GetLogsRequest) GetAppName added in v1.25.0 

func (m *GetLogsRequest) GetAppName() string

func (*GetLogsRequest) GetFollow added in v1.25.0 

func (m *GetLogsRequest) GetFollow() bool

func (*GetLogsRequest) GetLines added in v1.25.0 

func (m *GetLogsRequest) GetLines() int32

func (*GetLogsRequest) GetPodId added in v1.25.0 

func (m *GetLogsRequest) GetPodId() string

func (*GetLogsRequest) GetSinceTime added in v1.25.0 

func (m *GetLogsRequest) GetSinceTime() int64

func (*GetLogsRequest) GetUntilTime added in v1.25.0 

func (m *GetLogsRequest) GetUntilTime() int64

func (*GetLogsRequest) ProtoMessage 

func (*GetLogsRequest) ProtoMessage()

func (*GetLogsRequest) Reset 

func (m *GetLogsRequest) Reset()

func (*GetLogsRequest) String 

func (m *GetLogsRequest) String() string

type GetLogsResponse 

type GetLogsResponse struct {
	// List of the log lines that returned, optional as the response can contain no logs.
	Lines []string `protobuf:"bytes,1,rep,name=lines" json:"lines,omitempty"`
}

Response for GetLogs().

func (*GetLogsResponse) Descriptor added in v0.16.0 

func (*GetLogsResponse) Descriptor() ([]byte, []int)

func (*GetLogsResponse) GetLines added in v1.25.0 

func (m *GetLogsResponse) GetLines() []string

func (*GetLogsResponse) ProtoMessage 

func (*GetLogsResponse) ProtoMessage()

func (*GetLogsResponse) Reset 

func (m *GetLogsResponse) Reset()

func (*GetLogsResponse) String 

func (m *GetLogsResponse) String() string

type GlobalFlags added in v1.2.0 

type GlobalFlags struct {
	// Data directory.
	Dir string `protobuf:"bytes,1,opt,name=dir" json:"dir,omitempty"`
	// System configuration directory.
	SystemConfigDir string `protobuf:"bytes,2,opt,name=system_config_dir,json=systemConfigDir" json:"system_config_dir,omitempty"`
	// Local configuration directory.
	LocalConfigDir string `protobuf:"bytes,3,opt,name=local_config_dir,json=localConfigDir" json:"local_config_dir,omitempty"`
	// User configuration directory.
	UserConfigDir string `protobuf:"bytes,4,opt,name=user_config_dir,json=userConfigDir" json:"user_config_dir,omitempty"`
	// Insecure flags configurates what security features to disable.
	InsecureFlags string `protobuf:"bytes,5,opt,name=insecure_flags,json=insecureFlags" json:"insecure_flags,omitempty"`
	// Whether to automatically trust gpg keys fetched from https
	TrustKeysFromHttps bool `protobuf:"varint,6,opt,name=trust_keys_from_https,json=trustKeysFromHttps" json:"trust_keys_from_https,omitempty"`
}

GlobalFlags describes the flags that passed to rkt api service when it is launched.

func (*GlobalFlags) Descriptor added in v1.2.0 

func (*GlobalFlags) Descriptor() ([]byte, []int)

func (*GlobalFlags) GetDir added in v1.25.0 

func (m *GlobalFlags) GetDir() string

func (*GlobalFlags) GetInsecureFlags added in v1.25.0 

func (m *GlobalFlags) GetInsecureFlags() string

func (*GlobalFlags) GetLocalConfigDir added in v1.25.0 

func (m *GlobalFlags) GetLocalConfigDir() string

func (*GlobalFlags) GetSystemConfigDir added in v1.25.0 

func (m *GlobalFlags) GetSystemConfigDir() string

func (*GlobalFlags) GetTrustKeysFromHttps added in v1.25.0 

func (m *GlobalFlags) GetTrustKeysFromHttps() bool

func (*GlobalFlags) GetUserConfigDir added in v1.25.0 

func (m *GlobalFlags) GetUserConfigDir() string

func (*GlobalFlags) ProtoMessage added in v1.2.0 

func (*GlobalFlags) ProtoMessage()

func (*GlobalFlags) Reset added in v1.2.0 

func (m *GlobalFlags) Reset()

func (*GlobalFlags) String added in v1.2.0 

func (m *GlobalFlags) String() string

type Image 

type Image struct {
	// Base format of the image, required. This indicates the original format
	// for the image as nowadays all the image formats will be transformed to
	// ACI.
	BaseFormat *ImageFormat `protobuf:"bytes,1,opt,name=base_format,json=baseFormat" json:"base_format,omitempty"`
	// ID of the image, a string that can be used to uniquely identify the image,
	// e.g. sha512 hash of the ACIs, required.
	Id string `protobuf:"bytes,2,opt,name=id" json:"id,omitempty"`
	// Name of the image in the image manifest, e.g. 'coreos.com/etcd', optional.
	Name string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"`
	// Version of the image, e.g. 'latest', '2.0.10', optional.
	Version string `protobuf:"bytes,4,opt,name=version" json:"version,omitempty"`
	// Timestamp of when the image is imported, it is the seconds since epoch, optional.
	ImportTimestamp int64 `protobuf:"varint,5,opt,name=import_timestamp,json=importTimestamp" json:"import_timestamp,omitempty"`
	// JSON-encoded byte array that represents the image manifest, optional.
	Manifest []byte `protobuf:"bytes,6,opt,name=manifest,proto3" json:"manifest,omitempty"`
	// Size is the size in bytes of this image in the store.
	Size int64 `protobuf:"varint,7,opt,name=size" json:"size,omitempty"`
	// Annotations on this image.
	Annotations []*KeyValue `protobuf:"bytes,8,rep,name=annotations" json:"annotations,omitempty"`
	// Labels of this image.
	Labels []*KeyValue `protobuf:"bytes,9,rep,name=labels" json:"labels,omitempty"`
}

Image describes the image's information.

func (*Image) Descriptor added in v0.16.0 

func (*Image) Descriptor() ([]byte, []int)

func (*Image) GetAnnotations added in v0.15.0 

func (m *Image) GetAnnotations() []*KeyValue

func (*Image) GetBaseFormat 

func (m *Image) GetBaseFormat() *ImageFormat

func (*Image) GetId added in v1.25.0 

func (m *Image) GetId() string

func (*Image) GetImportTimestamp added in v1.25.0 

func (m *Image) GetImportTimestamp() int64

func (*Image) GetLabels added in v1.11.0 

func (m *Image) GetLabels() []*KeyValue

func (*Image) GetManifest added in v1.25.0 

func (m *Image) GetManifest() []byte

func (*Image) GetName added in v1.25.0 

func (m *Image) GetName() string

func (*Image) GetSize added in v1.25.0 

func (m *Image) GetSize() int64

func (*Image) GetVersion added in v1.25.0 

func (m *Image) GetVersion() string

func (*Image) ProtoMessage 

func (*Image) ProtoMessage()

func (*Image) Reset 

func (m *Image) Reset()

func (*Image) String 

func (m *Image) String() string

type ImageFilter 

type ImageFilter struct {
	// If not empty, the images that have any of the ids will be returned.
	Ids []string `protobuf:"bytes,1,rep,name=ids" json:"ids,omitempty"`
	// if not empty, the images that have any of the prefixes in the name will be returned.
	Prefixes []string `protobuf:"bytes,2,rep,name=prefixes" json:"prefixes,omitempty"`
	// If not empty, the images that have any of the base names will be returned.
	// For example, both 'coreos.com/etcd' and 'k8s.io/etcd' will be returned if 'etcd' is included,
	// however 'k8s.io/etcd-backup' will not be returned.
	BaseNames []string `protobuf:"bytes,3,rep,name=base_names,json=baseNames" json:"base_names,omitempty"`
	// If not empty, the images that have any of the keywords in the name will be returned.
	// For example, both 'kubernetes-etcd', 'etcd:latest' will be returned if 'etcd' is included,
	Keywords []string `protobuf:"bytes,4,rep,name=keywords" json:"keywords,omitempty"`
	// If not empty, the images that have all of the labels will be returned.
	Labels []*KeyValue `protobuf:"bytes,5,rep,name=labels" json:"labels,omitempty"`
	// If set, the images that are imported after this timestamp will be returned.
	ImportedAfter int64 `protobuf:"varint,6,opt,name=imported_after,json=importedAfter" json:"imported_after,omitempty"`
	// If set, the images that are imported before this timestamp will be returned.
	ImportedBefore int64 `protobuf:"varint,7,opt,name=imported_before,json=importedBefore" json:"imported_before,omitempty"`
	// If not empty, the images that have all of the annotations will be returned.
	Annotations []*KeyValue `protobuf:"bytes,8,rep,name=annotations" json:"annotations,omitempty"`
	// If not empty, the images that have any of the exact full names will be returned.
	FullNames []string `protobuf:"bytes,9,rep,name=full_names,json=fullNames" json:"full_names,omitempty"`
}

ImageFilter defines the condition that the returned images need to satisfy in ListImages(). The conditions are combined by 'AND', and different filters are combined by 'OR'.

func (*ImageFilter) Descriptor added in v0.16.0 

func (*ImageFilter) Descriptor() ([]byte, []int)

func (*ImageFilter) GetAnnotations 

func (m *ImageFilter) GetAnnotations() []*KeyValue

func (*ImageFilter) GetBaseNames added in v1.25.0 

func (m *ImageFilter) GetBaseNames() []string

func (*ImageFilter) GetFullNames added in v1.25.0 

func (m *ImageFilter) GetFullNames() []string

func (*ImageFilter) GetIds added in v1.25.0 

func (m *ImageFilter) GetIds() []string

func (*ImageFilter) GetImportedAfter added in v1.25.0 

func (m *ImageFilter) GetImportedAfter() int64

func (*ImageFilter) GetImportedBefore added in v1.25.0 

func (m *ImageFilter) GetImportedBefore() int64

func (*ImageFilter) GetKeywords added in v1.25.0 

func (m *ImageFilter) GetKeywords() []string

func (*ImageFilter) GetLabels 

func (m *ImageFilter) GetLabels() []*KeyValue

func (*ImageFilter) GetPrefixes added in v1.25.0 

func (m *ImageFilter) GetPrefixes() []string

func (*ImageFilter) ProtoMessage 

func (*ImageFilter) ProtoMessage()

func (*ImageFilter) Reset 

func (m *ImageFilter) Reset()

func (*ImageFilter) String 

func (m *ImageFilter) String() string

type ImageFormat 

type ImageFormat struct {
	// Type of the image, required.
	Type ImageType `protobuf:"varint,1,opt,name=type,enum=v1alpha.ImageType" json:"type,omitempty"`
	// Version of the image format, required.
	Version string `protobuf:"bytes,2,opt,name=version" json:"version,omitempty"`
}

ImageFormat defines the format of the image.

func (*ImageFormat) Descriptor added in v0.16.0 

func (*ImageFormat) Descriptor() ([]byte, []int)

func (*ImageFormat) GetType added in v1.25.0 

func (m *ImageFormat) GetType() ImageType

func (*ImageFormat) GetVersion added in v1.25.0 

func (m *ImageFormat) GetVersion() string

func (*ImageFormat) ProtoMessage 

func (*ImageFormat) ProtoMessage()

func (*ImageFormat) Reset 

func (m *ImageFormat) Reset()

func (*ImageFormat) String 

func (m *ImageFormat) String() string

type ImageType 

type ImageType int32

ImageType defines the supported image type. 

const (
	ImageType_IMAGE_TYPE_UNDEFINED ImageType = 0
	ImageType_IMAGE_TYPE_APPC      ImageType = 1
	ImageType_IMAGE_TYPE_DOCKER    ImageType = 2
	ImageType_IMAGE_TYPE_OCI       ImageType = 3
)

func (ImageType) EnumDescriptor added in v0.16.0 

func (ImageType) EnumDescriptor() ([]byte, []int)

func (ImageType) String 

func (x ImageType) String() string

type Info 

type Info struct {
	// Version of rkt, required, in the form of Semantic Versioning 2.0.0 (http://semver.org/).
	RktVersion string `protobuf:"bytes,1,opt,name=rkt_version,json=rktVersion" json:"rkt_version,omitempty"`
	// Version of appc, required, in the form of Semantic Versioning 2.0.0 (http://semver.org/).
	AppcVersion string `protobuf:"bytes,2,opt,name=appc_version,json=appcVersion" json:"appc_version,omitempty"`
	// Latest version of the api that's supported by the service, required, in the form of Semantic Versioning 2.0.0 (http://semver.org/).
	ApiVersion string `protobuf:"bytes,3,opt,name=api_version,json=apiVersion" json:"api_version,omitempty"`
	// The global flags that passed to the rkt api service when it's launched.
	GlobalFlags *GlobalFlags `protobuf:"bytes,4,opt,name=global_flags,json=globalFlags" json:"global_flags,omitempty"`
}

Info describes the information of rkt on the machine.

func (*Info) Descriptor added in v0.16.0 

func (*Info) Descriptor() ([]byte, []int)

func (*Info) GetApiVersion added in v1.25.0 

func (m *Info) GetApiVersion() string

func (*Info) GetAppcVersion added in v1.25.0 

func (m *Info) GetAppcVersion() string

func (*Info) GetGlobalFlags added in v1.2.0 

func (m *Info) GetGlobalFlags() *GlobalFlags

func (*Info) GetRktVersion added in v1.25.0 

func (m *Info) GetRktVersion() string

func (*Info) ProtoMessage 

func (*Info) ProtoMessage()

func (*Info) Reset 

func (m *Info) Reset()

func (*Info) String 

func (m *Info) String() string

type InspectImageRequest 

type InspectImageRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
}

Request for InspectImage().

func (*InspectImageRequest) Descriptor added in v0.16.0 

func (*InspectImageRequest) Descriptor() ([]byte, []int)

func (*InspectImageRequest) GetId added in v1.25.0 

func (m *InspectImageRequest) GetId() string

func (*InspectImageRequest) ProtoMessage 

func (*InspectImageRequest) ProtoMessage()

func (*InspectImageRequest) Reset 

func (m *InspectImageRequest) Reset()

func (*InspectImageRequest) String 

func (m *InspectImageRequest) String() string

type InspectImageResponse 

type InspectImageResponse struct {
	Image *Image `protobuf:"bytes,1,opt,name=image" json:"image,omitempty"`
}

Response for InspectImage().

func (*InspectImageResponse) Descriptor added in v0.16.0 

func (*InspectImageResponse) Descriptor() ([]byte, []int)

func (*InspectImageResponse) GetImage 

func (m *InspectImageResponse) GetImage() *Image

func (*InspectImageResponse) ProtoMessage 

func (*InspectImageResponse) ProtoMessage()

func (*InspectImageResponse) Reset 

func (m *InspectImageResponse) Reset()

func (*InspectImageResponse) String 

func (m *InspectImageResponse) String() string

type InspectPodRequest 

type InspectPodRequest struct {
	// ID of the pod which we are querying status for, required.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
}

Request for InspectPod().

func (*InspectPodRequest) Descriptor added in v0.16.0 

func (*InspectPodRequest) Descriptor() ([]byte, []int)

func (*InspectPodRequest) GetId added in v1.25.0 

func (m *InspectPodRequest) GetId() string

func (*InspectPodRequest) ProtoMessage 

func (*InspectPodRequest) ProtoMessage()

func (*InspectPodRequest) Reset 

func (m *InspectPodRequest) Reset()

func (*InspectPodRequest) String 

func (m *InspectPodRequest) String() string

type InspectPodResponse 

type InspectPodResponse struct {
	Pod *Pod `protobuf:"bytes,1,opt,name=pod" json:"pod,omitempty"`
}

Response for InspectPod().

func (*InspectPodResponse) Descriptor added in v0.16.0 

func (*InspectPodResponse) Descriptor() ([]byte, []int)

func (*InspectPodResponse) GetPod 

func (m *InspectPodResponse) GetPod() *Pod

func (*InspectPodResponse) ProtoMessage 

func (*InspectPodResponse) ProtoMessage()

func (*InspectPodResponse) Reset 

func (m *InspectPodResponse) Reset()

func (*InspectPodResponse) String 

func (m *InspectPodResponse) String() string

type KeyValue 

type KeyValue struct {
	// Key part of the key-value pair.
	Key string `protobuf:"bytes,1,opt,name=Key" json:"Key,omitempty"`
	// Value part of the key-value pair.
	Value string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
}

func (*KeyValue) Descriptor added in v0.16.0 

func (*KeyValue) Descriptor() ([]byte, []int)

func (*KeyValue) GetKey added in v1.25.0 

func (m *KeyValue) GetKey() string

func (*KeyValue) GetValue added in v1.25.0 

func (m *KeyValue) GetValue() string

func (*KeyValue) ProtoMessage 

func (*KeyValue) ProtoMessage()

func (*KeyValue) Reset 

func (m *KeyValue) Reset()

func (*KeyValue) String 

func (m *KeyValue) String() string

type ListImagesRequest 

type ListImagesRequest struct {
	Filters []*ImageFilter `protobuf:"bytes,1,rep,name=filters" json:"filters,omitempty"`
	Detail  bool           `protobuf:"varint,2,opt,name=detail" json:"detail,omitempty"`
}

Request for ListImages().

func (*ListImagesRequest) Descriptor added in v0.16.0 

func (*ListImagesRequest) Descriptor() ([]byte, []int)

func (*ListImagesRequest) GetDetail added in v1.25.0 

func (m *ListImagesRequest) GetDetail() bool

func (*ListImagesRequest) GetFilters added in v0.14.0 

func (m *ListImagesRequest) GetFilters() []*ImageFilter

func (*ListImagesRequest) ProtoMessage 

func (*ListImagesRequest) ProtoMessage()

func (*ListImagesRequest) Reset 

func (m *ListImagesRequest) Reset()

func (*ListImagesRequest) String 

func (m *ListImagesRequest) String() string

type ListImagesResponse 

type ListImagesResponse struct {
	Images []*Image `protobuf:"bytes,1,rep,name=images" json:"images,omitempty"`
}

Response for ListImages().

func (*ListImagesResponse) Descriptor added in v0.16.0 

func (*ListImagesResponse) Descriptor() ([]byte, []int)

func (*ListImagesResponse) GetImages 

func (m *ListImagesResponse) GetImages() []*Image

func (*ListImagesResponse) ProtoMessage 

func (*ListImagesResponse) ProtoMessage()

func (*ListImagesResponse) Reset 

func (m *ListImagesResponse) Reset()

func (*ListImagesResponse) String 

func (m *ListImagesResponse) String() string

type ListPodsRequest 

type ListPodsRequest struct {
	Filters []*PodFilter `protobuf:"bytes,1,rep,name=filters" json:"filters,omitempty"`
	Detail  bool         `protobuf:"varint,2,opt,name=detail" json:"detail,omitempty"`
}

Request for ListPods().

func (*ListPodsRequest) Descriptor added in v0.16.0 

func (*ListPodsRequest) Descriptor() ([]byte, []int)

func (*ListPodsRequest) GetDetail added in v1.25.0 

func (m *ListPodsRequest) GetDetail() bool

func (*ListPodsRequest) GetFilters added in v0.14.0 

func (m *ListPodsRequest) GetFilters() []*PodFilter

func (*ListPodsRequest) ProtoMessage 

func (*ListPodsRequest) ProtoMessage()

func (*ListPodsRequest) Reset 

func (m *ListPodsRequest) Reset()

func (*ListPodsRequest) String 

func (m *ListPodsRequest) String() string

type ListPodsResponse 

type ListPodsResponse struct {
	Pods []*Pod `protobuf:"bytes,1,rep,name=pods" json:"pods,omitempty"`
}

Response for ListPods().

func (*ListPodsResponse) Descriptor added in v0.16.0 

func (*ListPodsResponse) Descriptor() ([]byte, []int)

func (*ListPodsResponse) GetPods 

func (m *ListPodsResponse) GetPods() []*Pod

func (*ListPodsResponse) ProtoMessage 

func (*ListPodsResponse) ProtoMessage()

func (*ListPodsResponse) Reset 

func (m *ListPodsResponse) Reset()

func (*ListPodsResponse) String 

func (m *ListPodsResponse) String() string

type ListenEventsRequest 

type ListenEventsRequest struct {
	Filter *EventFilter `protobuf:"bytes,1,opt,name=filter" json:"filter,omitempty"`
}

Request for ListenEvents().

func (*ListenEventsRequest) Descriptor added in v0.16.0 

func (*ListenEventsRequest) Descriptor() ([]byte, []int)

func (*ListenEventsRequest) GetFilter 

func (m *ListenEventsRequest) GetFilter() *EventFilter

func (*ListenEventsRequest) ProtoMessage 

func (*ListenEventsRequest) ProtoMessage()

func (*ListenEventsRequest) Reset 

func (m *ListenEventsRequest) Reset()

func (*ListenEventsRequest) String 

func (m *ListenEventsRequest) String() string

type ListenEventsResponse 

type ListenEventsResponse struct {
	// Aggregate multiple events to reduce round trips, optional as the response can contain no events.
	Events []*Event `protobuf:"bytes,1,rep,name=events" json:"events,omitempty"`
}

Response for ListenEvents().

func (*ListenEventsResponse) Descriptor added in v0.16.0 

func (*ListenEventsResponse) Descriptor() ([]byte, []int)

func (*ListenEventsResponse) GetEvents 

func (m *ListenEventsResponse) GetEvents() []*Event

func (*ListenEventsResponse) ProtoMessage 

func (*ListenEventsResponse) ProtoMessage()

func (*ListenEventsResponse) Reset 

func (m *ListenEventsResponse) Reset()

func (*ListenEventsResponse) String 

func (m *ListenEventsResponse) String() string

type Network 

type Network struct {
	// Name of the network that a pod belongs to, required.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// Pod's IPv4 address within the network, optional if IPv6 address is given.
	Ipv4 string `protobuf:"bytes,2,opt,name=ipv4" json:"ipv4,omitempty"`
	// Pod's IPv6 address within the network, optional if IPv4 address is given.
	Ipv6 string `protobuf:"bytes,3,opt,name=ipv6" json:"ipv6,omitempty"`
}

Network describes the network information of a pod.

func (*Network) Descriptor added in v0.16.0 

func (*Network) Descriptor() ([]byte, []int)

func (*Network) GetIpv4 added in v1.25.0 

func (m *Network) GetIpv4() string

func (*Network) GetIpv6 added in v1.25.0 

func (m *Network) GetIpv6() string

func (*Network) GetName added in v1.25.0 

func (m *Network) GetName() string

func (*Network) ProtoMessage 

func (*Network) ProtoMessage()

func (*Network) Reset 

func (m *Network) Reset()

func (*Network) String 

func (m *Network) String() string

type Pod 

type Pod struct {
	// ID of the pod, in the form of a UUID.
	Id string `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// PID of the stage1 process of the pod.
	Pid int32 `protobuf:"zigzag32,2,opt,name=pid" json:"pid,omitempty"`
	// State of the pod.
	State PodState `protobuf:"varint,3,opt,name=state,enum=v1alpha.PodState" json:"state,omitempty"`
	// List of apps in the pod.
	Apps []*App `protobuf:"bytes,4,rep,name=apps" json:"apps,omitempty"`
	// Network information of the pod.
	// Note that a pod can be in multiple networks.
	Networks []*Network `protobuf:"bytes,5,rep,name=networks" json:"networks,omitempty"`
	// JSON-encoded byte array that represents the pod manifest of the pod.
	Manifest []byte `protobuf:"bytes,6,opt,name=manifest,proto3" json:"manifest,omitempty"`
	// Annotations on this pod.
	Annotations []*KeyValue `protobuf:"bytes,7,rep,name=annotations" json:"annotations,omitempty"`
	// Cgroup of the pod, empty if the pod is not running.
	Cgroup string `protobuf:"bytes,8,opt,name=cgroup" json:"cgroup,omitempty"`
	// Timestamp of when the pod is created, nanoseconds since epoch.
	// Zero if the pod is not created.
	CreatedAt int64 `protobuf:"varint,9,opt,name=created_at,json=createdAt" json:"created_at,omitempty"`
	// Timestamp of when the pod is started, nanoseconds since epoch.
	// Zero if the pod is not started.
	StartedAt int64 `protobuf:"varint,10,opt,name=started_at,json=startedAt" json:"started_at,omitempty"`
	// Timestamp of when the pod is moved to exited-garbage/garbage,
	// in nanoseconds since epoch.
	// Zero if the pod is not moved to exited-garbage/garbage yet.
	GcMarkedAt int64 `protobuf:"varint,11,opt,name=gc_marked_at,json=gcMarkedAt" json:"gc_marked_at,omitempty"`
}

Pod describes a pod's information. If a pod is in Embryo, Preparing, AbortedPrepare state, only id and state will be returned.

If a pod is in other states, the pod manifest and apps will be returned when 'detailed' is true in the request.

A valid pid of the stage1 process of the pod will be returned if the pod is Running has run once.

Networks are only returned when a pod is in Running.

func (*Pod) Descriptor added in v0.16.0 

func (*Pod) Descriptor() ([]byte, []int)

func (*Pod) GetAnnotations added in v0.15.0 

func (m *Pod) GetAnnotations() []*KeyValue

func (*Pod) GetApps 

func (m *Pod) GetApps() []*App

func (*Pod) GetCgroup added in v1.25.0 

func (m *Pod) GetCgroup() string

func (*Pod) GetCreatedAt added in v1.25.0 

func (m *Pod) GetCreatedAt() int64

func (*Pod) GetGcMarkedAt added in v1.25.0 

func (m *Pod) GetGcMarkedAt() int64

func (*Pod) GetId added in v1.25.0 

func (m *Pod) GetId() string

func (*Pod) GetManifest added in v1.25.0 

func (m *Pod) GetManifest() []byte

func (*Pod) GetNetworks 

func (m *Pod) GetNetworks() []*Network

func (*Pod) GetPid added in v1.25.0 

func (m *Pod) GetPid() int32

func (*Pod) GetStartedAt added in v1.25.0 

func (m *Pod) GetStartedAt() int64

func (*Pod) GetState added in v1.25.0 

func (m *Pod) GetState() PodState

func (*Pod) ProtoMessage 

func (*Pod) ProtoMessage()

func (*Pod) Reset 

func (m *Pod) Reset()

func (*Pod) String 

func (m *Pod) String() string

type PodFilter 

type PodFilter struct {
	// If not empty, the pods that have any of the ids will be returned.
	Ids []string `protobuf:"bytes,1,rep,name=ids" json:"ids,omitempty"`
	// If not empty, the pods that have any of the states will be returned.
	States []PodState `protobuf:"varint,2,rep,packed,name=states,enum=v1alpha.PodState" json:"states,omitempty"`
	// If not empty, the pods that all of the apps will be returned.
	AppNames []string `protobuf:"bytes,3,rep,name=app_names,json=appNames" json:"app_names,omitempty"`
	// If not empty, the pods that have all of the images(in the apps) will be returned
	ImageIds []string `protobuf:"bytes,4,rep,name=image_ids,json=imageIds" json:"image_ids,omitempty"`
	// If not empty, the pods that are in all of the networks will be returned.
	NetworkNames []string `protobuf:"bytes,5,rep,name=network_names,json=networkNames" json:"network_names,omitempty"`
	// If not empty, the pods that have all of the annotations will be returned.
	Annotations []*KeyValue `protobuf:"bytes,6,rep,name=annotations" json:"annotations,omitempty"`
	// If not empty, the pods whose cgroup are listed will be returned.
	Cgroups []string `protobuf:"bytes,7,rep,name=cgroups" json:"cgroups,omitempty"`
	// If not empty, the pods whose these cgroup belong to will be returned.
	// i.e. the pod's cgroup is a prefix of the specified cgroup
	PodSubCgroups []string `protobuf:"bytes,8,rep,name=pod_sub_cgroups,json=podSubCgroups" json:"pod_sub_cgroups,omitempty"`
}

PodFilter defines the condition that the returned pods need to satisfy in ListPods(). The conditions are combined by 'AND', and different filters are combined by 'OR'.

func (*PodFilter) Descriptor added in v0.16.0 

func (*PodFilter) Descriptor() ([]byte, []int)

func (*PodFilter) GetAnnotations 

func (m *PodFilter) GetAnnotations() []*KeyValue

func (*PodFilter) GetAppNames added in v1.25.0 

func (m *PodFilter) GetAppNames() []string

func (*PodFilter) GetCgroups added in v1.25.0 

func (m *PodFilter) GetCgroups() []string

func (*PodFilter) GetIds added in v1.25.0 

func (m *PodFilter) GetIds() []string

func (*PodFilter) GetImageIds added in v1.25.0 

func (m *PodFilter) GetImageIds() []string

func (*PodFilter) GetNetworkNames added in v1.25.0 

func (m *PodFilter) GetNetworkNames() []string

func (*PodFilter) GetPodSubCgroups added in v1.25.0 

func (m *PodFilter) GetPodSubCgroups() []string

func (*PodFilter) GetStates added in v1.25.0 

func (m *PodFilter) GetStates() []PodState

func (*PodFilter) ProtoMessage 

func (*PodFilter) ProtoMessage()

func (*PodFilter) Reset 

func (m *PodFilter) Reset()

func (*PodFilter) String 

func (m *PodFilter) String() string

type PodState 

type PodState int32

PodState defines the possible states of the pod. See https://github.com/rkt/rkt/blob/master/Documentation/devel/pod-lifecycle.md for a detailed explanation of each state. 

const (
	PodState_POD_STATE_UNDEFINED PodState = 0
	// States before the pod is running.
	PodState_POD_STATE_EMBRYO    PodState = 1
	PodState_POD_STATE_PREPARING PodState = 2
	PodState_POD_STATE_PREPARED  PodState = 3
	// State that indicates the pod is running.
	PodState_POD_STATE_RUNNING PodState = 4
	// States that indicates the pod is exited, and will never run.
	PodState_POD_STATE_ABORTED_PREPARE PodState = 5
	PodState_POD_STATE_EXITED          PodState = 6
	PodState_POD_STATE_DELETING        PodState = 7
	PodState_POD_STATE_GARBAGE         PodState = 8
)

func (PodState) EnumDescriptor added in v0.16.0 

func (PodState) EnumDescriptor() ([]byte, []int)

func (PodState) String 

func (x PodState) String() string

type PublicAPIClient 

type PublicAPIClient interface {
	// GetInfo gets the rkt's information on the machine.
	GetInfo(ctx context.Context, in *GetInfoRequest, opts ...grpc.CallOption) (*GetInfoResponse, error)
	// ListPods lists rkt pods on the machine.
	ListPods(ctx context.Context, in *ListPodsRequest, opts ...grpc.CallOption) (*ListPodsResponse, error)
	// InspectPod gets detailed pod information of the specified pod.
	InspectPod(ctx context.Context, in *InspectPodRequest, opts ...grpc.CallOption) (*InspectPodResponse, error)
	// ListImages lists the images on the machine.
	ListImages(ctx context.Context, in *ListImagesRequest, opts ...grpc.CallOption) (*ListImagesResponse, error)
	// InspectImage gets the detailed image information of the specified image.
	InspectImage(ctx context.Context, in *InspectImageRequest, opts ...grpc.CallOption) (*InspectImageResponse, error)
	// ListenEvents listens for the events, it will return a response stream
	// that will contain event objects.
	ListenEvents(ctx context.Context, in *ListenEventsRequest, opts ...grpc.CallOption) (PublicAPI_ListenEventsClient, error)
	// GetLogs gets the logs for a pod, if the app is also specified, then only the logs
	// of the app will be returned.
	//
	// If 'follow' in the 'GetLogsRequest' is set to 'true', then the response stream
	// will not be closed after the first response, the future logs will be sent via
	// the stream.
	GetLogs(ctx context.Context, in *GetLogsRequest, opts ...grpc.CallOption) (PublicAPI_GetLogsClient, error)
}

func NewPublicAPIClient 

func NewPublicAPIClient(cc *grpc.ClientConn) PublicAPIClient

type PublicAPIServer 

type PublicAPIServer interface {
	// GetInfo gets the rkt's information on the machine.
	GetInfo(context.Context, *GetInfoRequest) (*GetInfoResponse, error)
	// ListPods lists rkt pods on the machine.
	ListPods(context.Context, *ListPodsRequest) (*ListPodsResponse, error)
	// InspectPod gets detailed pod information of the specified pod.
	InspectPod(context.Context, *InspectPodRequest) (*InspectPodResponse, error)
	// ListImages lists the images on the machine.
	ListImages(context.Context, *ListImagesRequest) (*ListImagesResponse, error)
	// InspectImage gets the detailed image information of the specified image.
	InspectImage(context.Context, *InspectImageRequest) (*InspectImageResponse, error)
	// ListenEvents listens for the events, it will return a response stream
	// that will contain event objects.
	ListenEvents(*ListenEventsRequest, PublicAPI_ListenEventsServer) error
	// GetLogs gets the logs for a pod, if the app is also specified, then only the logs
	// of the app will be returned.
	//
	// If 'follow' in the 'GetLogsRequest' is set to 'true', then the response stream
	// will not be closed after the first response, the future logs will be sent via
	// the stream.
	GetLogs(*GetLogsRequest, PublicAPI_GetLogsServer) error
}

type PublicAPI_GetLogsClient 

type PublicAPI_GetLogsClient interface {
	Recv() (*GetLogsResponse, error)
	grpc.ClientStream
}

type PublicAPI_GetLogsServer 

type PublicAPI_GetLogsServer interface {
	Send(*GetLogsResponse) error
	grpc.ServerStream
}

type PublicAPI_ListenEventsClient 

type PublicAPI_ListenEventsClient interface {
	Recv() (*ListenEventsResponse, error)
	grpc.ClientStream
}

type PublicAPI_ListenEventsServer 

type PublicAPI_ListenEventsServer interface {
	Send(*ListenEventsResponse) error
	grpc.ServerStream
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.