ir

Documentation

Overview

Copyright 2022 The envd Authors

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

• Variables
• func Base(os, language, image string) error
• func CRANMirror(url string) error
• func CUDA(version, cudnn string)
• func Compile(ctx context.Context, cachePrefix string, pub string) (*llb.Definition, error)
• func CompileEntrypoint(buildContextDir string) ([]string, error)
• func CondaChannel(channel string) error
• func CondaPackage(deps []string, channel []string, envFile *string) error
• func Copy(src, dest string)
• func Entrypoint(args []string)
• func ExposedPorts() (map[string]struct{}, error)
• func GPU(numGPUs int)
• func GPUEnabled() bool
• func Git(name, email, editor string) error
• func JuliaPackage(deps []string)
• func JuliaPackageServer(url string) error
• func Jupyter(pwd string, port int64) error
• func Labels() (map[string]string, error)
• func Mount(src, dest string)
• func NumGPUs() int
• func PyPIIndex(mode, url, extraURL string) error
• func PyPIPackage(deps []string, requirementsFile *string) error
• func RPackage(deps []string)
• func RStudioServer() error
• func Run(commands []string) error
• func RuntimeCommands(commands map[string]string)
• func Shell(shell string) error
• func SystemPackage(deps []string)
• func UbuntuAPT(mode, source string) error
• func VSCodePlugins(plugins []string) error
• type CondaConfig
• type CopyInfo
• type GitConfig
• type Graph
  • func NewGraph() *Graph
  • func (g Graph) CacheID(filename string) string
  • func (g Graph) Compile(uid, gid int) (llb.State, error)
  • func (g Graph) CompileCacheDir(root llb.State, cacheDir string) llb.State
  • func (g Graph) CondaEnabled() bool
  • func (g Graph) DefaultCacheImporter() (*string, error)
  • func (g Graph) ExposedPorts() (map[string]struct{}, error)
  • func (g Graph) GPUEnabled() bool
  • func (g Graph) GetEntrypoint(buildContextDir string) ([]string, error)
  • func (g Graph) Labels() (map[string]string, error)
• type JupyterConfig
• type Language
• type MountInfo
• type RStudioServerConfig

Variables

var DefaultGraph = NewGraph()

Functions

func Base

func Base(os, language, image string) error

func CRANMirror

func CRANMirror(url string) error

func CUDA

func CUDA(version, cudnn string)

func Compile

func Compile(ctx context.Context, cachePrefix string, pub string) (*llb.Definition, error)

func CompileEntrypoint

func CompileEntrypoint(buildContextDir string) ([]string, error)

func CondaChannel

func CondaChannel(channel string) error

func CondaPackage

func CondaPackage(deps []string, channel []string, envFile *string) error

func Copy

func Copy(src, dest string)

func Entrypoint

func Entrypoint(args []string)

func ExposedPorts

func ExposedPorts() (map[string]struct{}, error)

func GPU

func GPU(numGPUs int)

func GPUEnabled

func GPUEnabled() bool

func Git

func Git(name, email, editor string) error

func JuliaPackage

func JuliaPackage(deps []string)

func JuliaPackageServer

func JuliaPackageServer(url string) error

func Jupyter

func Jupyter(pwd string, port int64) error

func Labels

func Labels() (map[string]string, error)

func Mount

func Mount(src, dest string)

func NumGPUs

func NumGPUs() int

func PyPIIndex

func PyPIIndex(mode, url, extraURL string) error

func PyPIPackage

func PyPIPackage(deps []string, requirementsFile *string) error

func RPackage

func RPackage(deps []string)

func RStudioServer

func RStudioServer() error

func Run

func Run(commands []string) error

func RuntimeCommands

func RuntimeCommands(commands map[string]string)

func Shell

func Shell(shell string) error

func SystemPackage

func SystemPackage(deps []string)

func UbuntuAPT

func UbuntuAPT(mode, source string) error

UbuntuAPT updates the Ubuntu apt source.list in the image.

func VSCodePlugins

func VSCodePlugins(plugins []string) error

Types

type CondaConfig

type CondaConfig struct {
	CondaPackages      []string
	AdditionalChannels []string
	CondaChannel       *string
}

type CopyInfo

type CopyInfo struct {
	Source      string
	Destination string
}

type GitConfig

type GitConfig struct {
	Name   string
	Email  string
	Editor string
}

type Graph

type Graph struct {
	OS string
	Language
	Image *string

	Shell   string
	CUDA    *string
	CUDNN   *string
	NumGPUs int

	UbuntuAPTSource    *string
	CRANMirrorURL      *string
	JuliaPackageServer *string
	PyPIIndexURL       *string
	PyPIExtraIndexURL  *string

	PublicKeyPath string

	PyPIPackages   []string
	RPackages      []string
	JuliaPackages  []string
	SystemPackages []string

	VSCodePlugins []vscode.Plugin

	Exec            []string
	Copy            []CopyInfo
	Mount           []MountInfo
	Entrypoint      []string
	RuntimeCommands map[string]string

	*JupyterConfig
	*GitConfig
	*CondaConfig
	*RStudioServerConfig

	Writer      compileui.Writer
	CachePrefix string
	// contains filtered or unexported fields
}

A Graph contains the state, such as its call stack and thread-local storage. TODO(gaocegeg): Refactor it to support order.

func NewGraph

func NewGraph() *Graph

func (Graph) CacheID

func (g Graph) CacheID(filename string) string

func (Graph) Compile

func (g Graph) Compile(uid, gid int) (llb.State, error)

func (Graph) CompileCacheDir

func (g Graph) CompileCacheDir(root llb.State, cacheDir string) llb.State

func (Graph) CondaEnabled

func (g Graph) CondaEnabled() bool

func (Graph) DefaultCacheImporter

func (g Graph) DefaultCacheImporter() (*string, error)

func (Graph) ExposedPorts

func (g Graph) ExposedPorts() (map[string]struct{}, error)

func (Graph) GPUEnabled

func (g Graph) GPUEnabled() bool

func (Graph) GetEntrypoint

func (g Graph) GetEntrypoint(buildContextDir string) ([]string, error)

func (Graph) Labels

func (g Graph) Labels() (map[string]string, error)

type JupyterConfig

type JupyterConfig struct {
	Token string
	Port  int64
}

type Language

type Language struct {
	Name    string
	Version *string
}

type MountInfo

type MountInfo struct {
	Source      string
	Destination string
}

type RStudioServerConfig

type RStudioServerConfig struct {
}