root.go

// Package docker presents a filesystem hierarchy for Docker resources.
//
// It uses local socket access or the DOCKER environment variables to
// access the Docker daemon.
package docker

import (
	"context"

	"github.com/docker/docker/client"
	"github.com/puppetlabs/wash/plugin"
)

// DOCKER ROOT

// Root of the Docker plugin
type Root struct {
	plugin.EntryBase
	resources []plugin.Entry
}

// Init for root
func (r *Root) Init(map[string]interface{}) error {
	dockerCli, err := client.NewClientWithOpts(client.FromEnv, client.WithAPIVersionNegotiation())
	if err != nil {
		return err
	}

	r.EntryBase = plugin.NewEntry("docker")
	r.DisableDefaultCaching()
	r.resources = []plugin.Entry{
		newContainersDir(dockerCli),
		newVolumesDir(dockerCli),
	}

	return nil
}

// Schema returns the root's schema
func (r *Root) Schema() *plugin.EntrySchema {
	return plugin.
		NewEntrySchema(r, "docker").
		SetDescription(rootDescription).
		IsSingleton()
}

// ChildSchemas returns the root's child schema
func (r *Root) ChildSchemas() []*plugin.EntrySchema {
	return []*plugin.EntrySchema{
		(&containersDir{}).Schema(),
		(&volumesDir{}).Schema(),
	}
}

// List lists the types of resources the Docker plugin exposes.
func (r *Root) List(ctx context.Context) ([]plugin.Entry, error) {
	return r.resources, nil
}

const rootDescription = `
This is the Docker plugin root. It lets you interact with Docker resources
like containers and volumes. These resources are found from the Docker socket
or via the DOCKER environment variables.
`