mconfig

type ContainerAllocation struct {
	Name  string `json:"name"`
	Ports []uint `json:"ports"`
}

type ContainerInformation struct {
	ID    string `json:"id"`
	Name  string `json:"name"`
	Ports []uint `json:"ports"`
}

type Context struct {
	// contains filtered or unexported fields
}

type Environment map[string]EnvironmentValue

type EnvironmentValue struct {
	// contains filtered or unexported fields
}

type Instruction string

type Plan struct {
	AppName        string                         `json:"app_name"`
	Profile        string                         `json:"profile"`
	Environment    map[string]string              `json:"environment"`
	AllocatedPorts map[uint]uint                  `json:"ports"`
	Containers     map[string]ContainerAllocation `json:"containers"` // Service id -> Container allocation
	Services       map[string]string              `json:"services"`   // Service id -> Data
}

type ServiceDriver interface {
	GetUniqueId() string

	// Should return the amount of ports required to start the container.
	GetRequiredPortAmount() int

	// Should return the image. Magic will pull it automatically.
	GetImage() string

	// Create a new container for this type of service
	CreateContainer(ctx context.Context, c *client.Client, a ContainerAllocation) (string, error)

	// This method should check if the container with the id is healthy for this service
	IsHealthy(ctx context.Context, c *client.Client, container ContainerInformation) (bool, error)

	// Called to initialize the container when it is healthy
	Initialize(ctx context.Context, c *client.Client, container ContainerInformation) error

	// An instruction sent down from Magic to potentially do something with the container (not every service has to handle every instruction).
	//
	// When implementing, please look into the instructions you can support.
	HandleInstruction(ctx context.Context, c *client.Client, container ContainerInformation, instruction Instruction) error

	// For creating a new instance of the service driver with the loaded data
	Load(data string) (ServiceDriver, error)

	// Save the current data of the service driver into string form (will be persisted in the plan)
	Save() (string, error)
}