Thoughts

commands

`create`

k3d
  |- create
  |       |- cluster [NAME ] [flags]
  |       |- node [NAME ] [flags]
  |
  |- delete
  |       |- cluster [NAME ] [flags]
  |       |- node [NAME ] [flags]
  |- get
  |    |- cluster
  |    |- node
  |- start
  |      |- cluster
  |      |- node
  |- stop
  |     |- cluster
  |     |- node

Overview

cmd/: everything around the CLI of k3 = human interface, printed output (e.g. list of clusters)
pkg/: everything else, can be used as a module from other Go projects
- cluster/: everything around managing cluster components
- runtimes/: translate k3d types (node, cluster, etc.) to container runtime specific types and manage them
- types/: collection of types (structs) and constants used by k3d
- util/: utilities, that could be used for everything, not directly related to the project

k3d <-> runtime

k3d should work with more than one runtime, if we can implement the Runtime interface for it. Here's how k3d types should translate to a runtime type:

cluster = set of containers running in the same network, maybe mounting the same volume(s)
node = container with exposed ports and volume mounts

docker

node -> container

container = "github.com/docker/docker/api/types/container" network = "github.com/docker/docker/api/types/network"

Name -> container.Hostname = node.Name
Role -> container.Labels["k3d.role"] = node.Role
Image -> container.Image = node.Image
Volumes -> container.HostConfig.PortBindings
Env ->
Args ->
Ports ->
Restart ->
Labels -> container.Labels

expose ports / volumes

--port [host:]port[:containerPort][/protocol][@group_identifier[[index] | @node_identifier]
- Examples:
  - --port 0.0.0.0:8080:8081/tcp@workers -> whole group
  - --port 80@workers[0] -> single instance of group by list index
  - --port 80@workers[0,2-3] -> multiple instances of a group by index lists and ranges
  - --port 80@k3d-test-worker-0 -> single instance by specific node identifier
  - --port 80@k3d-test-master-0@workers[1-5] -> multiple instances by combination of node and group identifiers
analogous for volumes

2.2 KiB Raw Blame History