pods

type Container struct {
	// Name is the container's name.
	Name string

	// Image is the OCI image that this container will run.
	Image string

	// Command is the entrypoint array. It's not executed within a shell.
	// The docker image's ENTRYPOINT is used if this is not provided. Cannot be updated.
	Command []string

	// Args passed to the Command. Cannot be updated.
	Args []string

	// Privileged defines if the container should run in privileged mode.
	Privileged *bool

	// AllowPrivilegeEscalation is used to define if the container is allowed to scale its privileges.
	AllowPrivilegeEscalation *bool

	// Ports is the list of ports that should be opened.
	Ports []int32

	// Volumes is the list of volumes that should be mounted in the container.
	Volumes []Volume

	// EnvVars is the list of env vars that should be passed into the container.
	EnvVars map[string]string

	// EnvVars is the list of env vars that should be gotten before passing them into the container.
	EnvVarsFrom map[string]string

	// ResourceRequests defines the minimum resources required for this container to run.
	ResourceRequests map[ResourceName]string

	// ResourceLimits defines the maximum amount of resources this container can use.
	ResourceLimits map[ResourceName]string
}

type CreatePodInput struct {
	// Name is the name of the pod that will be created.
	Name string

	// Namespace is the namespace where the pod will live in.
	Namespace string

	// Labels are the map of labels that will be applied to the pod.
	Labels map[string]string

	// ImagePullCredentials contains the names or paths of credentials used to pull OCI images from a container
	// registry.
	// For Kubernetes, this is equivalent to a pod's ImagePullSecrets.
	ImagePullCredentials []string

	// RestartPolicy defines how the pod should react after an error.
	RestartPolicy RestartPolicy

	// TerminationGracePeriodSeconds is the time duration in seconds the pod needs to terminate gracefully.
	TerminationGracePeriodSeconds time.Duration

	// NodeSelector defines the node where the pod should run in.
	NodeSelector resource.Selector

	// InitContainers is the list of containers that are created during pod initialization.
	// Init containers are launched before Containers, and are typically used to initialize the pod.
	InitContainers []Container

	// Containers is the list of containers that should be created inside the pod.
	Containers []Container

	// Volumes are the list of volumes that will be created to persist the data from the Container.Volumes.
	Volumes []Volume

	// Nameservers are the list of DNS Nameservers that will be used to expose the pod to the internet.
	Nameservers []string
}

type Executor interface {
	// Cmd runs a command inside a container.
	Cmd(container string, command []string) error
	// Script runs a script inside a container.
	// Could be used to run copy_to_s3.sh
	Script(container, path string) error
}

type HostPathType corev1.HostPathType

type PodResource struct {
	resource.Resource
	phase.ResourcePhase
	timestamp.ResourceTimestamp
}

type Pods interface {
	Create(ctx context.Context, input CreatePodInput) (*PodResource, error)
	Exec(ctx context.Context, resource resource.Resource) Executor
	Reader(ctx context.Context, resource resource.Resource) Reader
	WaitForCondition(ctx context.Context, resource resource.Resource, condition ...resource.Condition) waiter.Waiter
	Delete(ctx context.Context, resource resource.Resource) (resource.Resource, error)
	Get(ctx context.Context, name, namespace string) (*PodResource, error)
	GetIP(ctx context.Context, name string, namespace string) (string, error)
	List(ctx context.Context, namespace string, selector resource.Selector) ([]PodResource, error)
}

type Reader interface {
	File(ctx context.Context, container string, paths ...string) (*bytes.Buffer, error)
	Logs(ctx context.Context, container string, lines int64) (string, error)
}

type ResourceName corev1.ResourceName

type RestartPolicy corev1.RestartPolicy

type Volume interface {
	// Base contains generic information about the volume.
	Base() VolumeBase
}

type VolumeBase struct {
	// Name contains the name of the volume.
	Name string

	// MountPath is the path within the container at which the volume should be mounted.
	MountPath string

	// SubPath is an optional path within the mounted volume from which the container's volume should be mounted.
	// If not defined, the volume root will be used.
	SubPath string

	// ReadOnly indicates whether the volume should be mounted in read-only mode. Defaults to false.
	ReadOnly bool
}

type VolumeConfiguration struct {
	VolumeBase

	// ConfigurationName is the name of the configuration file to mount.
	ConfigurationName string

	// Items optionally defines the specific set of configuration entries to mount.
	// Keys indicate the items to mount, while values indicate where to mount them inside the volume.
	// If not defined the configuration will be mounted as a directory, with a file for each entry where the key of the
	// entry is the file name and the value the contents of the file.
	Items map[string]string
}

type VolumeHostPath struct {
	VolumeBase

	// HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the
	// container.
	HostPath string

	// HostPathType defines the mount type and mounting behavior.
	HostPathType HostPathType
}