Documentation
¶
Overview ¶
Package m8s is a generated protocol buffer package.
It is generated from these files:
m8s.proto
It has these top-level messages:
Credentials CreateRequest Metadata Annotation BasicAuth GitCheckout Compose ComposeService Resource CreateResponse StepRequest StepResponse DescribeRequest DescribeResponse ListRequest Init
Index ¶
- func RegisterM8SServer(s *grpc.Server, srv M8SServer)
- type Annotation
- type BasicAuth
- type Compose
- type ComposeService
- func (*ComposeService) Descriptor() ([]byte, []int)
- func (m *ComposeService) GetCapabilities() []string
- func (m *ComposeService) GetEntrypoint() []string
- func (m *ComposeService) GetEnvironment() []string
- func (m *ComposeService) GetExtrahosts() []string
- func (m *ComposeService) GetImage() string
- func (m *ComposeService) GetLimits() *Resource
- func (m *ComposeService) GetName() string
- func (m *ComposeService) GetPorts() []string
- func (m *ComposeService) GetReservations() *Resource
- func (m *ComposeService) GetTmpfs() []string
- func (m *ComposeService) GetType() string
- func (m *ComposeService) GetVolumes() []string
- func (*ComposeService) ProtoMessage()
- func (m *ComposeService) Reset()
- func (m *ComposeService) String() string
- type CreateRequest
- func (*CreateRequest) Descriptor() ([]byte, []int)
- func (m *CreateRequest) GetCompose() *Compose
- func (m *CreateRequest) GetCredentials() *Credentials
- func (m *CreateRequest) GetGitCheckout() *GitCheckout
- func (m *CreateRequest) GetMetadata() *Metadata
- func (m *CreateRequest) GetSteps() []*Init
- func (*CreateRequest) ProtoMessage()
- func (m *CreateRequest) Reset()
- func (m *CreateRequest) String() string
- type CreateResponse
- type Credentials
- type DescribeRequest
- type DescribeResponse
- func (*DescribeResponse) Descriptor() ([]byte, []int)
- func (m *DescribeResponse) GetContainers() []string
- func (m *DescribeResponse) GetDomains() []string
- func (m *DescribeResponse) GetName() string
- func (m *DescribeResponse) GetNamespace() string
- func (m *DescribeResponse) GetSSH() string
- func (*DescribeResponse) ProtoMessage()
- func (m *DescribeResponse) Reset()
- func (m *DescribeResponse) String() string
- type GitCheckout
- type Init
- func (*Init) Descriptor() ([]byte, []int)
- func (m *Init) GetImage() string
- func (m *Init) GetLimits() *Resource
- func (m *Init) GetName() string
- func (m *Init) GetReservations() *Resource
- func (m *Init) GetSteps() []string
- func (m *Init) GetVolumes() []string
- func (*Init) ProtoMessage()
- func (m *Init) Reset()
- func (m *Init) String() string
- type ListRequest
- type M8SClient
- type M8SServer
- type M8S_CreateClient
- type M8S_CreateServer
- type M8S_StepClient
- type M8S_StepServer
- type Metadata
- func (*Metadata) Descriptor() ([]byte, []int)
- func (m *Metadata) GetAnnotations() []*Annotation
- func (m *Metadata) GetBasicAuth() *BasicAuth
- func (m *Metadata) GetDomains() []string
- func (m *Metadata) GetName() string
- func (m *Metadata) GetRetention() string
- func (*Metadata) ProtoMessage()
- func (m *Metadata) Reset()
- func (m *Metadata) String() string
- type Resource
- type StepRequest
- func (*StepRequest) Descriptor() ([]byte, []int)
- func (m *StepRequest) GetCommand() string
- func (m *StepRequest) GetContainer() string
- func (m *StepRequest) GetCredentials() *Credentials
- func (m *StepRequest) GetName() string
- func (*StepRequest) ProtoMessage()
- func (m *StepRequest) Reset()
- func (m *StepRequest) String() string
- type StepResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterM8SServer ¶
Types ¶
type Annotation ¶
type Annotation struct { Name string `protobuf:"bytes,1,opt,name=Name" json:"Name,omitempty"` Value string `protobuf:"bytes,2,opt,name=Value" json:"Value,omitempty"` }
Annotation provides information about where the environment was triggered.
func (*Annotation) Descriptor ¶
func (*Annotation) Descriptor() ([]byte, []int)
func (*Annotation) GetName ¶
func (m *Annotation) GetName() string
func (*Annotation) GetValue ¶
func (m *Annotation) GetValue() string
func (*Annotation) ProtoMessage ¶
func (*Annotation) ProtoMessage()
func (*Annotation) Reset ¶
func (m *Annotation) Reset()
func (*Annotation) String ¶
func (m *Annotation) String() string
type BasicAuth ¶
type BasicAuth struct { User string `protobuf:"bytes,1,opt,name=User" json:"User,omitempty"` Pass string `protobuf:"bytes,2,opt,name=Pass" json:"Pass,omitempty"` }
func (*BasicAuth) Descriptor ¶
func (*BasicAuth) ProtoMessage ¶
func (*BasicAuth) ProtoMessage()
type Compose ¶
type Compose struct {
Services []*ComposeService `protobuf:"bytes,1,rep,name=Services" json:"Services,omitempty"`
}
Compose is our environment data, marshalled from a docker compose file.
func (*Compose) Descriptor ¶
func (*Compose) GetServices ¶
func (m *Compose) GetServices() []*ComposeService
func (*Compose) ProtoMessage ¶
func (*Compose) ProtoMessage()
type ComposeService ¶
type ComposeService struct { Name string `protobuf:"bytes,1,opt,name=Name" json:"Name,omitempty"` Image string `protobuf:"bytes,2,opt,name=Image" json:"Image,omitempty"` Limits *Resource `protobuf:"bytes,3,opt,name=Limits" json:"Limits,omitempty"` Reservations *Resource `protobuf:"bytes,4,opt,name=Reservations" json:"Reservations,omitempty"` Volumes []string `protobuf:"bytes,5,rep,name=Volumes" json:"Volumes,omitempty"` Ports []string `protobuf:"bytes,6,rep,name=Ports" json:"Ports,omitempty"` Environment []string `protobuf:"bytes,7,rep,name=Environment" json:"Environment,omitempty"` Tmpfs []string `protobuf:"bytes,8,rep,name=Tmpfs" json:"Tmpfs,omitempty"` Capabilities []string `protobuf:"bytes,9,rep,name=Capabilities" json:"Capabilities,omitempty"` Entrypoint []string `protobuf:"bytes,10,rep,name=Entrypoint" json:"Entrypoint,omitempty"` Extrahosts []string `protobuf:"bytes,11,rep,name=Extrahosts" json:"Extrahosts,omitempty"` Type string `protobuf:"bytes,12,opt,name=Type" json:"Type,omitempty"` }
ComposeService is a container defintion, which we will use to build a pod.
func (*ComposeService) Descriptor ¶
func (*ComposeService) Descriptor() ([]byte, []int)
func (*ComposeService) GetCapabilities ¶ added in v0.4.2
func (m *ComposeService) GetCapabilities() []string
func (*ComposeService) GetEntrypoint ¶ added in v0.7.0
func (m *ComposeService) GetEntrypoint() []string
func (*ComposeService) GetEnvironment ¶
func (m *ComposeService) GetEnvironment() []string
func (*ComposeService) GetExtrahosts ¶ added in v0.9.0
func (m *ComposeService) GetExtrahosts() []string
func (*ComposeService) GetImage ¶
func (m *ComposeService) GetImage() string
func (*ComposeService) GetLimits ¶
func (m *ComposeService) GetLimits() *Resource
func (*ComposeService) GetName ¶
func (m *ComposeService) GetName() string
func (*ComposeService) GetPorts ¶
func (m *ComposeService) GetPorts() []string
func (*ComposeService) GetReservations ¶
func (m *ComposeService) GetReservations() *Resource
func (*ComposeService) GetTmpfs ¶
func (m *ComposeService) GetTmpfs() []string
func (*ComposeService) GetType ¶ added in v0.8.0
func (m *ComposeService) GetType() string
func (*ComposeService) GetVolumes ¶
func (m *ComposeService) GetVolumes() []string
func (*ComposeService) ProtoMessage ¶
func (*ComposeService) ProtoMessage()
func (*ComposeService) Reset ¶
func (m *ComposeService) Reset()
func (*ComposeService) String ¶
func (m *ComposeService) String() string
type CreateRequest ¶
type CreateRequest struct { Credentials *Credentials `protobuf:"bytes,1,opt,name=Credentials" json:"Credentials,omitempty"` Metadata *Metadata `protobuf:"bytes,2,opt,name=Metadata" json:"Metadata,omitempty"` Compose *Compose `protobuf:"bytes,3,opt,name=Compose" json:"Compose,omitempty"` GitCheckout *GitCheckout `protobuf:"bytes,4,opt,name=GitCheckout" json:"GitCheckout,omitempty"` Steps []*Init `protobuf:"bytes,5,rep,name=Steps" json:"Steps,omitempty"` }
BuildRequest is used for submitting a new build.
func (*CreateRequest) Descriptor ¶
func (*CreateRequest) Descriptor() ([]byte, []int)
func (*CreateRequest) GetCompose ¶
func (m *CreateRequest) GetCompose() *Compose
func (*CreateRequest) GetCredentials ¶
func (m *CreateRequest) GetCredentials() *Credentials
func (*CreateRequest) GetGitCheckout ¶
func (m *CreateRequest) GetGitCheckout() *GitCheckout
func (*CreateRequest) GetMetadata ¶
func (m *CreateRequest) GetMetadata() *Metadata
func (*CreateRequest) GetSteps ¶ added in v0.8.0
func (m *CreateRequest) GetSteps() []*Init
func (*CreateRequest) ProtoMessage ¶
func (*CreateRequest) ProtoMessage()
func (*CreateRequest) Reset ¶
func (m *CreateRequest) Reset()
func (*CreateRequest) String ¶
func (m *CreateRequest) String() string
type CreateResponse ¶
type CreateResponse struct {
Message string `protobuf:"bytes,1,opt,name=Message" json:"Message,omitempty"`
}
BuildResponse is a streamed response used for printing build output and status.
func (*CreateResponse) Descriptor ¶
func (*CreateResponse) Descriptor() ([]byte, []int)
func (*CreateResponse) GetMessage ¶
func (m *CreateResponse) GetMessage() string
func (*CreateResponse) ProtoMessage ¶
func (*CreateResponse) ProtoMessage()
func (*CreateResponse) Reset ¶
func (m *CreateResponse) Reset()
func (*CreateResponse) String ¶
func (m *CreateResponse) String() string
type Credentials ¶
type Credentials struct {
Token string `protobuf:"bytes,1,opt,name=Token" json:"Token,omitempty"`
}
Credentials is used for authenicating with the PR service.
func (*Credentials) Descriptor ¶
func (*Credentials) Descriptor() ([]byte, []int)
func (*Credentials) GetToken ¶
func (m *Credentials) GetToken() string
func (*Credentials) ProtoMessage ¶
func (*Credentials) ProtoMessage()
func (*Credentials) Reset ¶
func (m *Credentials) Reset()
func (*Credentials) String ¶
func (m *Credentials) String() string
type DescribeRequest ¶
type DescribeRequest struct { Credentials *Credentials `protobuf:"bytes,1,opt,name=Credentials" json:"Credentials,omitempty"` Name string `protobuf:"bytes,2,opt,name=Name" json:"Name,omitempty"` }
DescribeRequest asks for an Environment which has already been deployed.
func (*DescribeRequest) Descriptor ¶
func (*DescribeRequest) Descriptor() ([]byte, []int)
func (*DescribeRequest) GetCredentials ¶
func (m *DescribeRequest) GetCredentials() *Credentials
func (*DescribeRequest) GetName ¶
func (m *DescribeRequest) GetName() string
func (*DescribeRequest) ProtoMessage ¶
func (*DescribeRequest) ProtoMessage()
func (*DescribeRequest) Reset ¶
func (m *DescribeRequest) Reset()
func (*DescribeRequest) String ¶
func (m *DescribeRequest) String() string
type DescribeResponse ¶
type DescribeResponse struct { Namespace string `protobuf:"bytes,1,opt,name=Namespace" json:"Namespace,omitempty"` Name string `protobuf:"bytes,2,opt,name=Name" json:"Name,omitempty"` Domains []string `protobuf:"bytes,3,rep,name=Domains" json:"Domains,omitempty"` Containers []string `protobuf:"bytes,4,rep,name=Containers" json:"Containers,omitempty"` SSH string `protobuf:"bytes,5,opt,name=SSH" json:"SSH,omitempty"` }
DescribeResponse responds with an Environment.
func (*DescribeResponse) Descriptor ¶
func (*DescribeResponse) Descriptor() ([]byte, []int)
func (*DescribeResponse) GetContainers ¶
func (m *DescribeResponse) GetContainers() []string
func (*DescribeResponse) GetDomains ¶
func (m *DescribeResponse) GetDomains() []string
func (*DescribeResponse) GetName ¶
func (m *DescribeResponse) GetName() string
func (*DescribeResponse) GetNamespace ¶
func (m *DescribeResponse) GetNamespace() string
func (*DescribeResponse) GetSSH ¶
func (m *DescribeResponse) GetSSH() string
func (*DescribeResponse) ProtoMessage ¶
func (*DescribeResponse) ProtoMessage()
func (*DescribeResponse) Reset ¶
func (m *DescribeResponse) Reset()
func (*DescribeResponse) String ¶
func (m *DescribeResponse) String() string
type GitCheckout ¶
type GitCheckout struct { // The repository we are cloning: // * https://github.com/owner/repo.git // * https://<token>:x-oauth-basic@github.com/owner/repo.git Repository string `protobuf:"bytes,1,opt,name=Repository" json:"Repository,omitempty"` Revision string `protobuf:"bytes,2,opt,name=Revision" json:"Revision,omitempty"` }
GitCheckout is the details required to checkout the codebase.
func (*GitCheckout) Descriptor ¶
func (*GitCheckout) Descriptor() ([]byte, []int)
func (*GitCheckout) GetRepository ¶
func (m *GitCheckout) GetRepository() string
func (*GitCheckout) GetRevision ¶
func (m *GitCheckout) GetRevision() string
func (*GitCheckout) ProtoMessage ¶
func (*GitCheckout) ProtoMessage()
func (*GitCheckout) Reset ¶
func (m *GitCheckout) Reset()
func (*GitCheckout) String ¶
func (m *GitCheckout) String() string
type Init ¶ added in v0.8.0
type Init struct { Name string `protobuf:"bytes,1,opt,name=Name" json:"Name,omitempty"` Image string `protobuf:"bytes,2,opt,name=Image" json:"Image,omitempty"` Steps []string `protobuf:"bytes,3,rep,name=Steps" json:"Steps,omitempty"` Limits *Resource `protobuf:"bytes,4,opt,name=Limits" json:"Limits,omitempty"` Reservations *Resource `protobuf:"bytes,5,opt,name=Reservations" json:"Reservations,omitempty"` Volumes []string `protobuf:"bytes,6,rep,name=Volumes" json:"Volumes,omitempty"` }
func (*Init) Descriptor ¶ added in v0.8.0
func (*Init) GetReservations ¶ added in v0.8.0
func (*Init) GetVolumes ¶ added in v0.8.0
func (*Init) ProtoMessage ¶ added in v0.8.0
func (*Init) ProtoMessage()
type ListRequest ¶
type ListRequest struct {
Credentials *Credentials `protobuf:"bytes,1,opt,name=Credentials" json:"Credentials,omitempty"`
}
DescribeRequest asks for all the Environments.
func (*ListRequest) Descriptor ¶
func (*ListRequest) Descriptor() ([]byte, []int)
func (*ListRequest) GetCredentials ¶
func (m *ListRequest) GetCredentials() *Credentials
func (*ListRequest) ProtoMessage ¶
func (*ListRequest) ProtoMessage()
func (*ListRequest) Reset ¶
func (m *ListRequest) Reset()
func (*ListRequest) String ¶
func (m *ListRequest) String() string
type M8SClient ¶
type M8SClient interface { Create(ctx context.Context, in *CreateRequest, opts ...grpc.CallOption) (M8S_CreateClient, error) Step(ctx context.Context, in *StepRequest, opts ...grpc.CallOption) (M8S_StepClient, error) Describe(ctx context.Context, in *DescribeRequest, opts ...grpc.CallOption) (*DescribeResponse, error) }
func NewM8SClient ¶
func NewM8SClient(cc *grpc.ClientConn) M8SClient
type M8SServer ¶
type M8SServer interface { Create(*CreateRequest, M8S_CreateServer) error Step(*StepRequest, M8S_StepServer) error Describe(context.Context, *DescribeRequest) (*DescribeResponse, error) }
type M8S_CreateClient ¶
type M8S_CreateClient interface { Recv() (*CreateResponse, error) grpc.ClientStream }
type M8S_CreateServer ¶
type M8S_CreateServer interface { Send(*CreateResponse) error grpc.ServerStream }
type M8S_StepClient ¶
type M8S_StepClient interface { Recv() (*StepResponse, error) grpc.ClientStream }
type M8S_StepServer ¶
type M8S_StepServer interface { Send(*StepResponse) error grpc.ServerStream }
type Metadata ¶
type Metadata struct { Name string `protobuf:"bytes,1,opt,name=Name" json:"Name,omitempty"` Annotations []*Annotation `protobuf:"bytes,2,rep,name=Annotations" json:"Annotations,omitempty"` Domains []string `protobuf:"bytes,3,rep,name=Domains" json:"Domains,omitempty"` BasicAuth *BasicAuth `protobuf:"bytes,4,opt,name=BasicAuth" json:"BasicAuth,omitempty"` Retention string `protobuf:"bytes,5,opt,name=Retention" json:"Retention,omitempty"` }
Metadata is high level information about the build.
func (*Metadata) Descriptor ¶
func (*Metadata) GetAnnotations ¶
func (m *Metadata) GetAnnotations() []*Annotation
func (*Metadata) GetBasicAuth ¶
func (*Metadata) GetDomains ¶
func (*Metadata) GetRetention ¶
func (*Metadata) ProtoMessage ¶
func (*Metadata) ProtoMessage()
type Resource ¶
type Resource struct { CPU string `protobuf:"bytes,1,opt,name=CPU" json:"CPU,omitempty"` Memory string `protobuf:"bytes,2,opt,name=Memory" json:"Memory,omitempty"` }
Resource is used for setting CPU and Memory of the build.
func (*Resource) Descriptor ¶
func (*Resource) ProtoMessage ¶
func (*Resource) ProtoMessage()
type StepRequest ¶
type StepRequest struct { Credentials *Credentials `protobuf:"bytes,1,opt,name=Credentials" json:"Credentials,omitempty"` Name string `protobuf:"bytes,2,opt,name=Name" json:"Name,omitempty"` Container string `protobuf:"bytes,3,opt,name=Container" json:"Container,omitempty"` Command string `protobuf:"bytes,4,opt,name=Command" json:"Command,omitempty"` }
StepRequest is our command being send to the remote environment.
func (*StepRequest) Descriptor ¶
func (*StepRequest) Descriptor() ([]byte, []int)
func (*StepRequest) GetCommand ¶
func (m *StepRequest) GetCommand() string
func (*StepRequest) GetContainer ¶
func (m *StepRequest) GetContainer() string
func (*StepRequest) GetCredentials ¶
func (m *StepRequest) GetCredentials() *Credentials
func (*StepRequest) GetName ¶
func (m *StepRequest) GetName() string
func (*StepRequest) ProtoMessage ¶
func (*StepRequest) ProtoMessage()
func (*StepRequest) Reset ¶
func (m *StepRequest) Reset()
func (*StepRequest) String ¶
func (m *StepRequest) String() string
type StepResponse ¶
type StepResponse struct {
Message string `protobuf:"bytes,1,opt,name=Message" json:"Message,omitempty"`
}
StepResponse is a streamed response used to return output from the commands on the remove environment.
func (*StepResponse) Descriptor ¶
func (*StepResponse) Descriptor() ([]byte, []int)
func (*StepResponse) GetMessage ¶
func (m *StepResponse) GetMessage() string
func (*StepResponse) ProtoMessage ¶
func (*StepResponse) ProtoMessage()
func (*StepResponse) Reset ¶
func (m *StepResponse) Reset()
func (*StepResponse) String ¶
func (m *StepResponse) String() string