etc

Documentation

Overview

Package etc provides configuration files for setting up common system programs like ssh, sshd, bash, notebooks, and tensorboard.

Index

• Constants
• func MustStaticFile(name string) []byte
• func SetRootPath(root string) error

Constants

const (
	// CommandEntrypointResource is the pre-flight script for commands.
	CommandEntrypointResource = "command-entrypoint.sh"
	// SSHConfigResource is the template SSH config file.
	SSHConfigResource = "ssh_config"
	// SSHDConfigResource is the template SSHD config file.
	SSHDConfigResource = "sshd_config"
	// ShellEntrypointResource is the script to set up sshd.
	ShellEntrypointResource = "shell-entrypoint.sh"
	// GCCheckpointsEntrypointResource is the script to run checkpoint GC.
	GCCheckpointsEntrypointResource = "gc-checkpoints-entrypoint.sh"
	// NotebookTemplateResource is the template notebook config file.
	NotebookTemplateResource = "notebook-template.ipynb"
	// NotebookEntrypointResource is the script to set up a notebook.
	NotebookEntrypointResource = "notebook-entrypoint.sh"
	// NotebookIdleCheckResource is the script to check if a notebook is idle.
	NotebookIdleCheckResource = "check_idle.py"
	// TaskCheckReadyLogsResource is the script to parse logs to check if a task is ready.
	TaskCheckReadyLogsResource = "check_ready_logs.py"
	// TaskShipLogsShellResource is the shell script to call the python script to ship logs.
	TaskShipLogsShellResource = "ship-logs.sh"
	// TaskShipLogsPythonResource is the python script to ship logs.
	TaskShipLogsPythonResource = "ship_logs.py"
	// TensorboardEntryScriptResource is the script to set up TensorBoard.
	TensorboardEntryScriptResource = "tensorboard-entrypoint.sh"
	// TrialEntrypointScriptResource is the script to set up a trial.
	TrialEntrypointScriptResource = "entrypoint.sh"
	// AgentSetupScriptTemplateResource is the template for the script to run a dynamic agent.
	AgentSetupScriptTemplateResource = "agent_setup_script.sh.template"
	// K8InitContainerEntryScriptResource is the script to run the init container on k8s.
	K8InitContainerEntryScriptResource = "k8_init_container_entrypoint.sh"
	// TaskSetupScriptResource is the script to setup various things for all tasks.
	TaskSetupScriptResource = "task-setup.sh"
	// SingularityEntrypointWrapperScriptResource is the entrypoint for singularity containers.
	SingularityEntrypointWrapperScriptResource = "singularity-entrypoint-wrapper.sh"
)

Functions

func MustStaticFile

func MustStaticFile(name string) []byte

MustStaticFile returns the content of the file with the provided name as a byte array.

func SetRootPath

func SetRootPath(root string) error

SetRootPath sets the path relative to which the paths for resources are resolved.