Portainer DevKit

A. Features

1. One-click to create Docker, Swarm and K8s Environments
2. One-click to run and debug Portainer in Docker and K8s
3. One-click to run and debug Agent and Edge-Agent in Docker, Swarm and K8s

B. Prerequisites

• Install Docker
• Install curl

C. Get Started

1. start portainer workspace

mkdir /tmp/devkit
PORTAINER_WORKSPACE="/tmp/devkit" DEVKIT_DEBUG="false" \
bash -c "`curl -s https://raw.githubusercontent.com/mcpacino/portainer-devkit/main/devkit/devkit`"

2. open vscode http://localhost:3000

D. Debug Portainer EE in Workspace

1. Open Folder of Portainer EE

2. Run Portainer EE in Workspace

3. Visit Portainer EE http://localhost:9000

E. Debug Agent in K8s

1. Open Folder of Agent

2. Run Agent in K8s

3. Building Agent and Starting K8s

4. Add a K8s Agent Environment

5. Check the K8s Agent Environment is Up

F. Debug Edge Agent in K8s for Portainer EE

1. Create an Edge Agent Environment

2. Copy the Edge Token

3. Paste the Edge Token to tasks.json file (Note: use the EDGE_KEY_EE_K8S key)

4. Run Edge Agent in K8s for EE

5. Check the K8s Edge Agent Environment is Associated

G. Containers Overview

+===========================================================+
|  Container Name: portainer-workspace                      |
+===========================================================+
|  Host Name:      w01                                      |
|  IP Addr:        192.168.100.10                           |
|  Expose:         3000 (vscode)                            |
|                  9000,9443 (portainer in workspace)       |
+===========================================================+
|  Running Apps:   vscode, portainer                        |
+===========================================================+
|  Port Mapping:   3000:3000                                |
|                  9000:9000                                |
|                  9443:9443                                |
+===========================================================+


+===========================================================+
|  Container Name: portainer-k8s-control-plane              |
+===========================================================+
|  Host Name:      k01                                      |
|  IP Addr:        192.168.100.1                            |
|  Expose:         30778 (agent)                            |
|                  9000,9443 (portainer in k8s)             |
+===========================================================+
|  Running Apps:   k8s, agent, portainer                    |
+===========================================================+
|  Port Mapping:   19000:9000                               |
|                  19443:9443                               |
+===========================================================+


+===========================================================+
|  Container Name: portainer-swarm                          |
+===========================================================+
|  Host Name:      s01                                      |
|  IP Addr:        192.168.100.2                            |
|  Expose:         9001 (agent)                             |
+===========================================================+
|  Running Apps:   swarm, agent                             |
+===========================================================+


+===========================================================+
|  Container Name: portainer-docker                         |
+===========================================================+
|  Host Name:      d01                                      |
|  IP Addr:        192.168.100.3                            |
|  Expose:         9001 (agent)                             |
+===========================================================+
|  Running Apps:   docker, agent                            |
+===========================================================+