types

Documentation

Index

• type AuthNRequest
• type AuthNResponse
• type AuthStatus
• type EnvVar
• type Environment
• type EnvironmentCreateRequest
• type EnvironmentCreateResponse
• type EnvironmentGetRequest
• type EnvironmentGetResponse
• type EnvironmentListRequest
• type EnvironmentListResponse
• type EnvironmentPort
• type EnvironmentRemoveRequest
• type EnvironmentRemoveResponse
• type EnvironmentRepoInfo
• type EnvironmentSpec
• type EnvironmentStatus
• type ImageGetRequest
• type ImageGetResponse
• type ImageInfo
• type ImageListRequest
• type ImageListResponse
• type ImageMeta
• type KeyCreateRequest
• type KeyCreateResponse
• type ObjectMeta
• type ResourceSpec

Types

type AuthNRequest

type AuthNRequest struct {
	// LoginName is used to authenticate the user and get
	// an access token for the registry.
	LoginName string `json:"login_name,omitempty" example:"alice"`

	// Password stores the hashed password.
	Password string `json:"password,omitempty"`
}

AuthNRequest contains authorization information for connecting to a envd server.

type AuthNResponse

type AuthNResponse struct {
	// LoginName is used to authenticate the user and get
	// an access token for the registry.
	LoginName string `json:"login_name,omitempty" example:"alice"`
	// An opaque token used to authenticate a user after a successful login
	// Required: true
	IdentityToken string `json:"identity_token" example:"a332139d39b89a241400013700e665a3"`
	// The status of the authentication
	// Required: true
	Status AuthStatus `json:"status" example:"Login successfully"`
}

type AuthStatus

type AuthStatus string

const (
	AuthSuccess AuthStatus = "Login succeeded"
	AuthFail    AuthStatus = "Login Fail"
	Error       AuthStatus = "Internal_Error"
)

type EnvVar

type EnvVar struct {
	// Name of the environment variable. Must be a C_IDENTIFIER.
	Name string `json:"name"`

	// Variable references $(VAR_NAME) are expanded
	// using the previously defined environment variables in the container and
	// any service environment variables. If a variable cannot be resolved,
	// the reference in the input string will be unchanged. Double $$ are reduced
	// to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
	// "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
	// Escaped references will never be expanded, regardless of whether the variable
	// exists or not.
	// Defaults to "".
	// +optional
	Value string `json:"value,omitempty"`
}

type Environment

type Environment struct {
	ObjectMeta `json:",inline"`
	Spec       EnvironmentSpec   `json:"spec,omitempty"`
	Status     EnvironmentStatus `json:"status,omitempty"`
	Resources  ResourceSpec      `json:"resource,omitempty"`
	CreatedAt  int64             `json:"created_at,omitempty"`
}

type EnvironmentCreateRequest

type EnvironmentCreateRequest struct {
	Environment `json:",inline,omitempty"`
}

type EnvironmentCreateResponse

type EnvironmentCreateResponse struct {
	Created Environment `json:"environment,omitempty"`

	// Warnings encountered when creating the pod
	// Required: true
	Warnings []string `json:"warnings,omitempty"`
}

type EnvironmentGetRequest

type EnvironmentGetRequest struct {
	Name string `uri:"name" example:"pytorch-example"`
}

type EnvironmentGetResponse

type EnvironmentGetResponse struct {
	Environment `json:",inline"`
}

type EnvironmentListRequest

type EnvironmentListRequest struct {
}

type EnvironmentListResponse

type EnvironmentListResponse struct {
	Items []Environment `json:"items,omitempty"`
}

type EnvironmentPort

type EnvironmentPort struct {
	Name string `json:"name,omitempty"`
	Port int32  `json:"port,omitempty"`
}

type EnvironmentRemoveRequest

type EnvironmentRemoveRequest struct {
	Name string `uri:"name" example:"pytorch-example"`
}

type EnvironmentRemoveResponse

type EnvironmentRemoveResponse struct {
}

type EnvironmentRepoInfo

type EnvironmentRepoInfo struct {
	URL         string `json:"url,omitempty"`
	Description string `json:"description,omitempty"`
}

type EnvironmentSpec

type EnvironmentSpec struct {
	Owner          string            `json:"owner,omitempty"`
	Image          string            `json:"image,omitempty"`
	Env            []EnvVar          `json:"env,omitempty"`
	Cmd            []string          `json:"cmd,omitempty"`
	Ports          []EnvironmentPort `json:"ports,omitempty"`
	APTPackages    []string          `json:"apt_packages,omitempty"`
	PythonCommands []string          `json:"pypi_commands,omitempty"`
}

type EnvironmentStatus

type EnvironmentStatus struct {
	Phase             string  `json:"phase,omitempty"`
	JupyterAddr       *string `json:"jupyter_addr,omitempty"`
	RStudioServerAddr *string `json:"rstudio_server_addr,omitempty"`
}

type ImageGetRequest

type ImageGetRequest struct {
	Name string `uri:"name" example:"pytorch-example"`
}

type ImageGetResponse

type ImageGetResponse struct {
	ImageMeta `json:",inline"`
}

type ImageInfo

type ImageInfo struct {
	OwnerToken string
	ImageMeta
}

type ImageListRequest

type ImageListRequest struct {
}

type ImageListResponse

type ImageListResponse struct {
	Items []ImageMeta `json:"items,omitempty"`
}

type ImageMeta

type ImageMeta struct {
	Name           string            `json:"name,omitempty" example:"pytorch-cuda:dev"`
	Digest         string            `json:"digest,omitempty"`
	Created        int64             `json:"created,omitempty"`
	Size           int64             `json:"size,omitempty"`
	Labels         map[string]string `json:"labels,omitempty"`
	APTPackages    []string          `json:"apt_packages,omitempty"`
	PythonCommands []string          `json:"python_commands,omitempty"`
	Ports          []EnvironmentPort `json:"ports,omitempty"`
}

type KeyCreateRequest

type KeyCreateRequest struct {
	// Name is the key name.
	Name string `json:"name,omitempty" example:"mykey"`
	// PublicKey is the ssh public key
	PublicKey string `json:"public_key,omitempty"`
}

type KeyCreateResponse

type KeyCreateResponse struct {
	// Name is the key name.
	Name string `json:"name,omitempty" example:"mykey"`
	// PublicKey is the ssh public key
	PublicKey string `json:"public_key,omitempty"`
	// LoginName is used to authenticate the user and get
	// an access token for the registry.
	LoginName string `json:"login_name,omitempty" example:"alice"`
}

type ObjectMeta

type ObjectMeta struct {
	Name string `json:"name,omitempty"`

	Labels      map[string]string `json:"labels,omitempty"`
	Annotations map[string]string `json:"annotations,omitempty"`
}

type ResourceSpec

type ResourceSpec struct {
	CPU    string `json:"cpu,omitempty"`
	Memory string `json:"memory,omitempty"`
	GPU    string `json:"gpu,omitempty"`
}