Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for nerdctl compose #665

Closed
wants to merge 1 commit into from
Closed

Add support for nerdctl compose #665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions backend/dockge-server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ export class DockgeServer {
io : socketIO.Server;
config : Config;
indexHTML : string = "";
dockerPath : string = "";

/**
* List of express routers
Expand Down Expand Up @@ -136,7 +137,11 @@ export class DockgeServer {
stacksDir: {
type: String,
optional: true,
}
},
dockerPath: {
type: String,
optional: true,
},
});

this.config = args as Config;
Expand All @@ -149,7 +154,9 @@ export class DockgeServer {
this.config.hostname = args.hostname || process.env.DOCKGE_HOSTNAME || undefined;
this.config.dataDir = args.dataDir || process.env.DOCKGE_DATA_DIR || "./data/";
this.config.stacksDir = args.stacksDir || process.env.DOCKGE_STACKS_DIR || defaultStacksDir;
this.config.dockerPath = args.dockerPath || process.env.DOCKGE_DOCKER_PATH || "docker";
this.stacksDir = this.config.stacksDir;
this.dockerPath = this.config.dockerPath;

log.debug("server", this.config);

Expand Down Expand Up @@ -611,7 +618,7 @@ export class DockgeServer {
}

async getDockerNetworkList() : Promise<string[]> {
let res = await childProcessAsync.spawn("docker", [ "network", "ls", "--format", "{{.Name}}" ], {
let res = await childProcessAsync.spawn(this.dockerPath, [ "network", "ls", "--format", "{{.Name}}" ], {
encoding: "utf-8",
});

Expand Down
131 changes: 96 additions & 35 deletions backend/stack.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ import { InteractiveTerminal, Terminal } from "./terminal";
import childProcessAsync from "promisify-child-process";
import { Settings } from "./settings";

interface composeListStatus {
Name: string;
Status: string;
ConfigFiles: string;
}

export class Stack {

name: string;
Expand Down Expand Up @@ -93,7 +99,7 @@ export class Stack {
* Get the status of the stack from `docker compose ps --format json`
*/
async ps() : Promise<object> {
let res = await childProcessAsync.spawn("docker", [ "compose", "ps", "--format", "json" ], {
let res = await childProcessAsync.spawn(this.server.dockerPath, [ "compose", "ps", "--format", "json" ], {
cwd: this.path,
encoding: "utf-8",
});
Expand Down Expand Up @@ -208,7 +214,7 @@ export class Stack {

async deploy(socket : DockgeSocket) : Promise<number> {
const terminalName = getComposeTerminalName(socket.endpoint, this.name);
let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "up", "-d", "--remove-orphans" ], this.path);
let exitCode = await Terminal.exec(this.server, socket, terminalName, this.server.dockerPath, [ "compose", "up", "-d", "--remove-orphans" ], this.path);
if (exitCode !== 0) {
throw new Error("Failed to deploy, please check the terminal output for more information.");
}
Expand All @@ -217,7 +223,7 @@ export class Stack {

async delete(socket: DockgeSocket) : Promise<number> {
const terminalName = getComposeTerminalName(socket.endpoint, this.name);
let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "down", "--remove-orphans" ], this.path);
let exitCode = await Terminal.exec(this.server, socket, terminalName, this.server.dockerPath, [ "compose", "down", "--remove-orphans" ], this.path);
if (exitCode !== 0) {
throw new Error("Failed to delete, please check the terminal output for more information.");
}
Expand All @@ -231,8 +237,8 @@ export class Stack {
return exitCode;
}

async updateStatus() {
let statusList = await Stack.getStatusList();
async updateStatus(server: DockgeServer) {
let statusList = await Stack.getStatusList(server);
let status = statusList.get(this.name);

if (status) {
Expand Down Expand Up @@ -301,15 +307,7 @@ export class Stack {
}

// Get status from docker compose ls
let res = await childProcessAsync.spawn("docker", [ "compose", "ls", "--all", "--format", "json" ], {
encoding: "utf-8",
});

if (!res.stdout) {
return stackList;
}

let composeList = JSON.parse(res.stdout.toString());
let composeList = await this.getStackComposeList(server);

for (let composeStack of composeList) {
let stack = stackList.get(composeStack.Name);
Expand All @@ -331,22 +329,85 @@ export class Stack {
return stackList;
}

static async getStackComposeList(server: DockgeServer): Promise<IterableIterator<composeListStatus>> {
let stacksDir = server.stacksDir;
let statusList = new Array<composeListStatus>();

// Scan the stacks directory, and get the stack list
let filenameList = await fsAsync.readdir(stacksDir);

for (const filename of filenameList) {
try {
// Check if it is a directory
let stat = await fsAsync.stat(path.join(stacksDir, filename));
if (!stat.isDirectory()) {
continue;
}

// Find existing compose files
let composeFile = "";
let filenamePath = path.join(stacksDir, filename);
for (const filename of acceptedComposeFileNames) {
composeFile = path.join(filenamePath, filename);
if (await fileExists(composeFile)) {
break;
}
composeFile = "";
}

// If no compose file exists, skip it
if (composeFile == "") {
continue;
}

let res = await childProcessAsync.spawn(server.dockerPath, ["compose", "-f", composeFile, "ps", "--all", "--format", "json"], {
encoding: "utf-8",
});

if (!res.stdout) {
return statusList.values();
}

// If no container exists, skip it
let composeList = JSON.parse(res.stdout.toString());
if (composeList.length == 0) {
continue;
}

// Converts the container state to composeListStatus, result of command: docker compose ls --format json ...
let statusCounter = new Map<string, number>();
for (let composeStack of composeList) {
statusCounter.set(composeStack.State, (statusCounter.get(composeStack.State) || 0) + 1);
}

let statusStr = new Array<string>();
for (const key of statusCounter.keys()) {
statusStr.push(`${key}(${statusCounter.get(key)})`);
}

let status: composeListStatus = {
Name: filename,
Status: statusStr.join(","),
ConfigFiles: composeFile,
};

statusList.push(status);
} catch (e) {
if (e instanceof Error) {
log.warn("getStackList", `Failed to get stack ${filename}, error: ${e.message}`);
}
}
}

return statusList.values();
}
/**
* Get the status list, it will be used to update the status of the stacks
* Not all status will be returned, only the stack that is deployed or created to `docker compose` will be returned
*/
static async getStatusList() : Promise<Map<string, number>> {
static async getStatusList(server: DockgeServer) : Promise<Map<string, number>> {
let statusList = new Map<string, number>();

let res = await childProcessAsync.spawn("docker", [ "compose", "ls", "--all", "--format", "json" ], {
encoding: "utf-8",
});

if (!res.stdout) {
return statusList;
}

let composeList = JSON.parse(res.stdout.toString());
let composeList = await this.getStackComposeList(server);

for (let composeStack of composeList) {
statusList.set(composeStack.Name, this.statusConvert(composeStack.Status));
Expand Down Expand Up @@ -409,7 +470,7 @@ export class Stack {

async start(socket: DockgeSocket) {
const terminalName = getComposeTerminalName(socket.endpoint, this.name);
let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "up", "-d", "--remove-orphans" ], this.path);
let exitCode = await Terminal.exec(this.server, socket, terminalName, this.server.dockerPath, [ "compose", "up", "-d", "--remove-orphans" ], this.path);
if (exitCode !== 0) {
throw new Error("Failed to start, please check the terminal output for more information.");
}
Expand All @@ -418,7 +479,7 @@ export class Stack {

async stop(socket: DockgeSocket) : Promise<number> {
const terminalName = getComposeTerminalName(socket.endpoint, this.name);
let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "stop" ], this.path);
let exitCode = await Terminal.exec(this.server, socket, terminalName, this.server.dockerPath, [ "compose", "stop" ], this.path);
if (exitCode !== 0) {
throw new Error("Failed to stop, please check the terminal output for more information.");
}
Expand All @@ -427,7 +488,7 @@ export class Stack {

async restart(socket: DockgeSocket) : Promise<number> {
const terminalName = getComposeTerminalName(socket.endpoint, this.name);
let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "restart" ], this.path);
let exitCode = await Terminal.exec(this.server, socket, terminalName, this.server.dockerPath, [ "compose", "restart" ], this.path);
if (exitCode !== 0) {
throw new Error("Failed to restart, please check the terminal output for more information.");
}
Expand All @@ -436,7 +497,7 @@ export class Stack {

async down(socket: DockgeSocket) : Promise<number> {
const terminalName = getComposeTerminalName(socket.endpoint, this.name);
let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "down" ], this.path);
let exitCode = await Terminal.exec(this.server, socket, terminalName, this.server.dockerPath, [ "compose", "down" ], this.path);
if (exitCode !== 0) {
throw new Error("Failed to down, please check the terminal output for more information.");
}
Expand All @@ -445,19 +506,19 @@ export class Stack {

async update(socket: DockgeSocket) {
const terminalName = getComposeTerminalName(socket.endpoint, this.name);
let exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "pull" ], this.path);
let exitCode = await Terminal.exec(this.server, socket, terminalName, this.server.dockerPath, [ "compose", "pull" ], this.path);
if (exitCode !== 0) {
throw new Error("Failed to pull, please check the terminal output for more information.");
}

// If the stack is not running, we don't need to restart it
await this.updateStatus();
await this.updateStatus(this.server);
log.debug("update", "Status: " + this.status);
if (this.status !== RUNNING) {
return exitCode;
}

exitCode = await Terminal.exec(this.server, socket, terminalName, "docker", [ "compose", "up", "-d", "--remove-orphans" ], this.path);
exitCode = await Terminal.exec(this.server, socket, terminalName, this.server.dockerPath, [ "compose", "up", "-d", "--remove-orphans" ], this.path);
if (exitCode !== 0) {
throw new Error("Failed to restart, please check the terminal output for more information.");
}
Expand All @@ -466,7 +527,7 @@ export class Stack {

async joinCombinedTerminal(socket: DockgeSocket) {
const terminalName = getCombinedTerminalName(socket.endpoint, this.name);
const terminal = Terminal.getOrCreateTerminal(this.server, terminalName, "docker", [ "compose", "logs", "-f", "--tail", "100" ], this.path);
const terminal = Terminal.getOrCreateTerminal(this.server, terminalName, this.server.dockerPath, [ "compose", "logs", "-f", "--tail", "100" ], this.path);
terminal.enableKeepAlive = true;
terminal.rows = COMBINED_TERMINAL_ROWS;
terminal.cols = COMBINED_TERMINAL_COLS;
Expand All @@ -487,7 +548,7 @@ export class Stack {
let terminal = Terminal.getTerminal(terminalName);

if (!terminal) {
terminal = new InteractiveTerminal(this.server, terminalName, "docker", [ "compose", "exec", serviceName, shell ], this.path);
terminal = new InteractiveTerminal(this.server, terminalName, this.server.dockerPath, [ "compose", "exec", serviceName, shell ], this.path);
terminal.rows = TERMINAL_ROWS;
log.debug("joinContainerTerminal", "Terminal created");
}
Expand All @@ -500,7 +561,7 @@ export class Stack {
let statusList = new Map<string, number>();

try {
let res = await childProcessAsync.spawn("docker", [ "compose", "ps", "--format", "json" ], {
let res = await childProcessAsync.spawn(this.server.dockerPath, [ "compose", "ps", "--format", "json" ], {
cwd: this.path,
encoding: "utf-8",
});
Expand Down
1 change: 1 addition & 0 deletions backend/util-server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export interface Arguments {
hostname? : string;
dataDir? : string;
stacksDir? : string;
dockerPath? : string;
}

// Some config values are required
Expand Down
1 change: 1 addition & 0 deletions common/util-common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ export const ERROR_TYPE_VALIDATION = 1;

export const allowedCommandList : string[] = [
"docker",
"nerdctl",
"ls",
"cd",
"dir",
Expand Down
1 change: 1 addition & 0 deletions compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ services:
environment:
# Tell Dockge where is your stacks directory
- DOCKGE_STACKS_DIR=/opt/stacks
- DOCKGE_DOCKER_PATH=docker # or nerdctl
Loading