Compare commits

..

20 Commits

Author SHA1 Message Date
740f83114c 1.1.4 2024-06-06 00:32:51 +02:00
e48023d490 fix(core): update 2024-06-06 00:32:50 +02:00
eaaf313442 1.1.3 2024-06-06 00:25:40 +02:00
68b2baadae fix(core): update 2024-06-06 00:25:39 +02:00
6743dc35e7 1.1.2 2024-06-06 00:14:31 +02:00
bbf265716d fix(core): update 2024-06-06 00:14:30 +02:00
3a705534fe 1.1.1 2024-06-05 23:56:03 +02:00
cbdbd32dd1 fix(core): update 2024-06-05 23:56:02 +02:00
224004217c 1.1.0 2024-06-05 14:10:45 +02:00
e06ef454a6 feat(images): can now import and export images, start work on local 100% JS oci imageregistry 2024-06-05 14:10:44 +02:00
a5f4d93f50 1.0.112 2024-05-08 20:35:17 +02:00
9f5d2cacf1 fix(core): update 2024-05-08 20:35:16 +02:00
d9112d3e04 1.0.111 2024-05-08 19:58:09 +02:00
455404c3c9 fix(core): update 2024-05-08 19:58:09 +02:00
90089625dc 1.0.110 2024-04-23 20:10:37 +02:00
86d5cc1d47 fix(core): update 2024-04-23 20:10:36 +02:00
6407033694 1.0.109 2024-04-23 19:58:05 +02:00
9dd69868d9 fix(core): update 2024-04-23 19:58:04 +02:00
dc4074340d 1.0.108 2024-02-02 16:55:52 +01:00
001e870643 fix(core): update 2024-02-02 16:55:51 +01:00
20 changed files with 4261 additions and 3774 deletions

View File

@ -15,9 +15,23 @@
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "mojoio", "gitscope": "mojoio",
"gitrepo": "docker", "gitrepo": "docker",
"description": "unofficial docker engine api abstraction package written in TypeScript", "description": "Provides easy communication with Docker remote API from Node.js, with TypeScript support.",
"npmPackagename": "@mojoio/docker", "npmPackagename": "@mojoio/docker",
"license": "MIT" "license": "MIT",
} "keywords": [
"Docker",
"API",
"Node.js",
"TypeScript",
"Containers",
"Images",
"Networks",
"Services",
"Secrets"
]
}
},
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
} }
} }

View File

@ -1,7 +1,7 @@
{ {
"name": "@apiclient.xyz/docker", "name": "@apiclient.xyz/docker",
"version": "1.0.107", "version": "1.1.4",
"description": "easy communication with docker remote api from node, TypeScript ready", "description": "Provides easy communication with Docker remote API from Node.js, with TypeScript support.",
"private": false, "private": false,
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
@ -16,11 +16,15 @@
"url": "git+https://gitlab.com/mojoio/docker.git" "url": "git+https://gitlab.com/mojoio/docker.git"
}, },
"keywords": [ "keywords": [
"docker", "Docker",
"sock", "API",
"container", "Node.js",
"request", "TypeScript",
"api" "Containers",
"Images",
"Networks",
"Services",
"Secrets"
], ],
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
@ -29,25 +33,28 @@
}, },
"homepage": "https://gitlab.com/mojoio/docker#readme", "homepage": "https://gitlab.com/mojoio/docker#readme",
"dependencies": { "dependencies": {
"@push.rocks/lik": "^6.0.0", "@push.rocks/lik": "^6.0.15",
"@push.rocks/smartfile": "^11.0.4", "@push.rocks/smartarchive": "^4.0.22",
"@push.rocks/smartjson": "^5.0.2", "@push.rocks/smartbucket": "^3.0.10",
"@push.rocks/smartlog": "^3.0.1", "@push.rocks/smartfile": "^11.0.16",
"@push.rocks/smartjson": "^5.0.20",
"@push.rocks/smartlog": "^3.0.6",
"@push.rocks/smartnetwork": "^3.0.0", "@push.rocks/smartnetwork": "^3.0.0",
"@push.rocks/smartpath": "^5.0.5", "@push.rocks/smartpath": "^5.0.18",
"@push.rocks/smartpromise": "^4.0.3", "@push.rocks/smartpromise": "^4.0.3",
"@push.rocks/smartrequest": "^2.0.11", "@push.rocks/smartrequest": "^2.0.22",
"@push.rocks/smartstring": "^4.0.5", "@push.rocks/smartstream": "^3.0.44",
"@push.rocks/smartversion": "^3.0.2", "@push.rocks/smartstring": "^4.0.15",
"@tsclass/tsclass": "^4.0.24", "@push.rocks/smartversion": "^3.0.5",
"@tsclass/tsclass": "^4.0.54",
"rxjs": "^7.5.7" "rxjs": "^7.5.7"
}, },
"devDependencies": { "devDependencies": {
"@git.zone/tsbuild": "^2.1.25", "@git.zone/tsbuild": "^2.1.80",
"@git.zone/tsrun": "^1.2.12", "@git.zone/tsrun": "^1.2.12",
"@git.zone/tstest": "^1.0.52", "@git.zone/tstest": "^1.0.90",
"@push.rocks/tapbundle": "^5.0.4", "@push.rocks/tapbundle": "^5.0.23",
"@types/node": "^20.11.16" "@types/node": "20.14.1"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",

7466
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

0
readme.hints.md Normal file
View File

173
readme.md
View File

@ -1,49 +1,152 @@
# @mojoio/docker # @apiclient.xyz/docker
unofficial docker engine api abstraction package written in TypeScript
## Availabililty and Links easy communication with docker remote api from node, TypeScript ready
* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/docker)
* [gitlab.com (source)](https://gitlab.com/mojoio/docker)
* [github.com (source mirror)](https://github.com/mojoio/docker)
* [docs (typedoc)](https://mojoio.gitlab.io/docker/)
## Status for master ## Install
Status Category | Status Badge To install @apiclient.xyz/docker, you can use npm (npm package manager). Run the following command in your terminal:
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/mojoio/docker/badges/master/pipeline.svg)](https://lossless.cloud) ```bash
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/mojoio/docker/badges/master/coverage.svg)](https://lossless.cloud) npm install @apiclient.xyz/docker --save
npm | [![npm downloads per month](https://badgen.net/npm/dy/@mojoio/docker)](https://lossless.cloud) ```
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/mojoio/docker)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud) This command installs the package and adds it as a dependency to your project's `package.json` file.
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@mojoio/docker)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@mojoio/docker)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@mojoio/docker)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage ## Usage
Use TypeScript for best in class instellisense. The `@apiclient.xyz/docker` package provides a TypeScript-ready interface for interacting with Docker's Remote API directly from Node.js applications. It leverages TypeScript for strong type definitions, ensuring more reliable and maintainable code.
### Prerequisites
Before you begin, ensure:
- You have Docker installed and running on your machine or a remote server.
- You are familiar with TypeScript and have it set up in your development environment.
### Getting Started
First, import the required classes from the package:
```typescript ```typescript
import { DockerHost } from '@mojoio/docker'; // require Dockersock class import { DockerHost, DockerContainer, DockerService, DockerNetwork } from '@apiclient.xyz/docker';
const run = async () => {
const myDockerHost = new DockerHost(); // optional: you can pass a domain to the contructor, defaults to /var/run/docker.sock
const containers = await myDockerHost.getContainers(); // promise, resolve with an array of DockerContainers
};
``` ```
## Contribution ### Instantiate DockerHost
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :) Start by creating a `DockerHost` instance. This class is the entry point to communicate with the Docker Remote API.
For further information read the linked docs at the top of this readme. ```typescript
// Connect to local Docker instance
const localDockerHost = new DockerHost();
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) // Or specify a custom path or URL to a Docker host
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy) const remoteDockerHost = new DockerHost('tcp://<REMOTE_DOCKER_HOST>:2375');
```
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com) ### Working with Containers
#### List All Containers
```typescript
async function listAllContainers() {
const containers = await localDockerHost.getContainers();
console.log(containers);
}
listAllContainers();
```
#### Create and Remove a Container
```typescript
import { IContainerCreationDescriptor } from '@apiclient.xyz/docker';
async function createAndRemoveContainer() {
const containerDescriptor: IContainerCreationDescriptor = {
Hostname: 'test-container',
Domainname: '',
// Additional settings here
};
// Create container
const container = await DockerContainer.create(localDockerHost, containerDescriptor);
console.log(`Container Created: ${container.Id}`);
// Remove container
await container.remove();
console.log(`Container Removed: ${container.Id}`);
}
createAndRemoveContainer();
```
### Working with Docker Services
#### Create a Docker Service
```typescript
import { IServiceCreationDescriptor } from '@apiclient.xyz/docker';
async function createDockerService() {
const serviceDescriptor: IServiceCreationDescriptor = {
name: 'my-service',
image: 'nginx:latest', // Docker Image
// Additional settings
};
const service = await DockerService.createService(localDockerHost, serviceDescriptor);
console.log(`Service Created: ${service.Id}`);
}
createDockerService();
```
### Working with Docker Networks
#### Listing and Creating Networks
```typescript
async function listAndCreateNetwork() {
// List all networks
const networks = await localDockerHost.getNetworks();
console.log(networks);
// Create a new network
const network = await DockerNetwork.createNetwork(localDockerHost, {
Name: 'my-network'
// Additional settings
});
console.log(`Network Created: ${network.Id}`);
}
listAndCreateNetwork();
```
### Advanced Usage
You can leverage the full potential of the Docker Remote API with `@apiclient.xyz/docker`. This includes managing images, volumes, swarms, and more. The package's design is consistent and intuitive, making it easy to extend your usage as needed.
Remember, the Docker Remote API offers extensive capabilities. Always refer to the [Docker API documentation](https://docs.docker.com/engine/api/latest/) for a comprehensive list of endpoints and actions you can perform.
### Conclusion
`@apiclient.xyz/docker` simplifies interaction with Docker's Remote API in TypeScript projects, providing strong typing and asynchronous operations. Whether you're managing containers, images, services or networks, it offers a comprehensive toolset to perform these tasks seamlessly.
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

View File

@ -1,10 +1,14 @@
import { expect, tap } from '@push.rocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import * as plugins from '../ts/plugins.js';
import * as paths from '../ts/paths.js';
import * as docker from '../ts/index.js'; import * as docker from '../ts/index.js';
let testDockerHost: docker.DockerHost; let testDockerHost: docker.DockerHost;
tap.test('should create a new Dockersock instance', async () => { tap.test('should create a new Dockersock instance', async () => {
testDockerHost = new docker.DockerHost(); testDockerHost = new docker.DockerHost({});
return expect(testDockerHost).toBeInstanceOf(docker.DockerHost); return expect(testDockerHost).toBeInstanceOf(docker.DockerHost);
}); });
@ -40,8 +44,10 @@ tap.test('should remove a network', async () => {
// Images // Images
tap.test('should pull an image from imagetag', async () => { tap.test('should pull an image from imagetag', async () => {
const image = await docker.DockerImage.createFromRegistry(testDockerHost, { const image = await docker.DockerImage.createFromRegistry(testDockerHost, {
creationObject: {
imageUrl: 'hosttoday/ht-docker-node', imageUrl: 'hosttoday/ht-docker-node',
imageTag: 'alpine', imageTag: 'alpine',
},
}); });
expect(image).toBeInstanceOf(docker.DockerImage); expect(image).toBeInstanceOf(docker.DockerImage);
console.log(image); console.log(image);
@ -93,7 +99,9 @@ tap.test('should create a service', async () => {
contentArg: '{"hi": "wow"}', contentArg: '{"hi": "wow"}',
}); });
const testImage = await docker.DockerImage.createFromRegistry(testDockerHost, { const testImage = await docker.DockerImage.createFromRegistry(testDockerHost, {
imageUrl: 'registry.gitlab.com/hosttoday/ht-docker-static', creationObject: {
imageUrl: 'code.foss.global/host.today/ht-docker-node:latest',
}
}); });
const testService = await docker.DockerService.createService(testDockerHost, { const testService = await docker.DockerService.createService(testDockerHost, {
image: testImage, image: testImage,
@ -110,4 +118,34 @@ tap.test('should create a service', async () => {
await testSecret.remove(); await testSecret.remove();
}); });
tap.start(); tap.test('should export images', async (toolsArg) => {
const done = toolsArg.defer();
const testImage = await docker.DockerImage.createFromRegistry(testDockerHost, {
creationObject: {
imageUrl: 'code.foss.global/host.today/ht-docker-node:latest',
}
});
const fsWriteStream = plugins.smartfile.fsStream.createWriteStream(
plugins.path.join(paths.nogitDir, 'testimage.tar')
);
const exportStream = await testImage.exportToTarStream();
exportStream.pipe(fsWriteStream).on('finish', () => {
done.resolve();
});
await done.promise;
});
tap.test('should import images', async (toolsArg) => {
const done = toolsArg.defer();
const fsReadStream = plugins.smartfile.fsStream.createReadStream(
plugins.path.join(paths.nogitDir, 'testimage.tar')
);
await docker.DockerImage.createFromTarStream(testDockerHost, {
tarStream: fsReadStream,
creationObject: {
imageUrl: 'code.foss.global/host.today/ht-docker-node:latest',
}
})
})
export default tap.start();

View File

@ -3,6 +3,6 @@
*/ */
export const commitinfo = { export const commitinfo = {
name: '@apiclient.xyz/docker', name: '@apiclient.xyz/docker',
version: '1.0.107', version: '1.1.4',
description: 'easy communication with docker remote api from node, TypeScript ready' description: 'Provides easy communication with Docker remote API from Node.js, with TypeScript support.'
} }

View File

@ -1,8 +1,8 @@
import * as plugins from './docker.plugins.js'; import * as plugins from './plugins.js';
import * as interfaces from './interfaces/index.js'; import * as interfaces from './interfaces/index.js';
import { DockerHost } from './docker.classes.host.js'; import { DockerHost } from './classes.host.js';
import { logger } from './docker.logging.js'; import { logger } from './logging.js';
export class DockerContainer { export class DockerContainer {
// STATIC // STATIC

View File

@ -1,9 +1,10 @@
import * as plugins from './docker.plugins.js'; import * as plugins from './plugins.js';
import { DockerContainer } from './docker.classes.container.js'; import { DockerContainer } from './classes.container.js';
import { DockerNetwork } from './docker.classes.network.js'; import { DockerNetwork } from './classes.network.js';
import { DockerService } from './docker.classes.service.js'; import { DockerService } from './classes.service.js';
import { logger } from './docker.logging.js'; import { logger } from './logging.js';
import path from 'path'; import path from 'path';
import type { DockerImageStore } from './classes.imagestore.js';
export interface IAuthData { export interface IAuthData {
serveraddress: string; serveraddress: string;
@ -11,21 +12,27 @@ export interface IAuthData {
password: string; password: string;
} }
export interface IDockerHostConstructorOptions {
dockerSockPath?: string;
imageStoreDir?: string;
}
export class DockerHost { export class DockerHost {
/** /**
* the path where the docker sock can be found * the path where the docker sock can be found
*/ */
public socketPath: string; public socketPath: string;
private registryToken: string = ''; private registryToken: string = '';
public imageStore: DockerImageStore;
/** /**
* the constructor to instantiate a new docker sock instance * the constructor to instantiate a new docker sock instance
* @param pathArg * @param pathArg
*/ */
constructor(pathArg?: string) { constructor(optionsArg: IDockerHostConstructorOptions) {
let pathToUse: string; let pathToUse: string;
if (pathArg) { if (optionsArg.dockerSockPath) {
pathToUse = pathArg; pathToUse = optionsArg.dockerSockPath;
} else if (process.env.DOCKER_HOST) { } else if (process.env.DOCKER_HOST) {
pathToUse = process.env.DOCKER_HOST; pathToUse = process.env.DOCKER_HOST;
} else if (process.env.CI) { } else if (process.env.CI) {
@ -34,7 +41,10 @@ export class DockerHost {
pathToUse = 'http://unix:/var/run/docker.sock:'; pathToUse = 'http://unix:/var/run/docker.sock:';
} }
if (pathToUse.startsWith('unix:///')) { if (pathToUse.startsWith('unix:///')) {
pathToUse = pathToUse.replace('unix://', 'http://unix:') + ':'; pathToUse = pathToUse.replace('unix://', 'http://unix:');
}
if (pathToUse.endsWith('.sock')) {
pathToUse = pathToUse.replace('.sock', '.sock:');
} }
console.log(`using docker sock at ${pathToUse}`); console.log(`using docker sock at ${pathToUse}`);
this.socketPath = pathToUse; this.socketPath = pathToUse;
@ -58,16 +68,16 @@ export class DockerHost {
/** /**
* gets the token from the .docker/config.json file for GitLab registry * gets the token from the .docker/config.json file for GitLab registry
*/ */
public async getGitlabComTokenFromDockerConfig() { public async getAuthTokenFromDockerConfig(registryUrlArg: string) {
const dockerConfigPath = plugins.smartpath.get.home('~/.docker/config.json'); const dockerConfigPath = plugins.smartpath.get.home('~/.docker/config.json');
const configObject = plugins.smartfile.fs.toObjectSync(dockerConfigPath); const configObject = plugins.smartfile.fs.toObjectSync(dockerConfigPath);
const gitlabAuthBase64 = configObject.auths['registry.gitlab.com'].auth; const gitlabAuthBase64 = configObject.auths[registryUrlArg].auth;
const gitlabAuth: string = plugins.smartstring.base64.decode(gitlabAuthBase64); const gitlabAuth: string = plugins.smartstring.base64.decode(gitlabAuthBase64);
const gitlabAuthArray = gitlabAuth.split(':'); const gitlabAuthArray = gitlabAuth.split(':');
await this.auth({ await this.auth({
username: gitlabAuthArray[0], username: gitlabAuthArray[0],
password: gitlabAuthArray[1], password: gitlabAuthArray[1],
serveraddress: 'registry.gitlab.com', serveraddress: registryUrlArg,
}); });
} }
@ -171,7 +181,7 @@ export class DockerHost {
return response; return response;
} }
public async requestStreaming(methodArg: string, routeArg: string, dataArg = {}) { public async requestStreaming(methodArg: string, routeArg: string, readStream?: plugins.smartstream.stream.Readable) {
const requestUrl = `${this.socketPath}${routeArg}`; const requestUrl = `${this.socketPath}${routeArg}`;
const response = await plugins.smartrequest.request( const response = await plugins.smartrequest.request(
requestUrl, requestUrl,
@ -185,7 +195,20 @@ export class DockerHost {
requestBody: null, requestBody: null,
keepAlive: false, keepAlive: false,
}, },
true true,
(readStream ? reqArg => {
let counter = 0;
const smartduplex = new plugins.smartstream.SmartDuplex({
writeFunction: async (chunkArg) => {
if (counter % 1000 === 0) {
console.log(`posting chunk ${counter}`);
}
counter++;
return chunkArg;
}
});
readStream.pipe(smartduplex).pipe(reqArg);
} : null),
); );
console.log(response.statusCode); console.log(response.statusCode);
console.log(response.body); console.log(response.body);

View File

@ -1,7 +1,7 @@
import * as plugins from './docker.plugins.js'; import * as plugins from './plugins.js';
import * as interfaces from './interfaces/index.js'; import * as interfaces from './interfaces/index.js';
import { DockerHost } from './docker.classes.host.js'; import { DockerHost } from './classes.host.js';
import { logger } from './docker.logging.js'; import { logger } from './logging.js';
export class DockerImage { export class DockerImage {
// STATIC // STATIC
@ -28,7 +28,9 @@ export class DockerImage {
public static async createFromRegistry( public static async createFromRegistry(
dockerHostArg: DockerHost, dockerHostArg: DockerHost,
optionsArg: {
creationObject: interfaces.IImageCreationDescriptor creationObject: interfaces.IImageCreationDescriptor
}
): Promise<DockerImage> { ): Promise<DockerImage> {
// lets create a sanatized imageUrlObject // lets create a sanatized imageUrlObject
const imageUrlObject: { const imageUrlObject: {
@ -36,8 +38,8 @@ export class DockerImage {
imageTag: string; imageTag: string;
imageOriginTag: string; imageOriginTag: string;
} = { } = {
imageUrl: creationObject.imageUrl, imageUrl: optionsArg.creationObject.imageUrl,
imageTag: creationObject.imageTag, imageTag: optionsArg.creationObject.imageTag,
imageOriginTag: null, imageOriginTag: null,
}; };
if (imageUrlObject.imageUrl.includes(':')) { if (imageUrlObject.imageUrl.includes(':')) {
@ -72,6 +74,19 @@ export class DockerImage {
} }
} }
/**
*
* @param dockerHostArg
* @param tarStreamArg
*/
public static async createFromTarStream(dockerHostArg: DockerHost, optionsArg: {
creationObject: interfaces.IImageCreationDescriptor,
tarStream: plugins.smartstream.stream.Readable,
}) {
const response = await dockerHostArg.requestStreaming('POST', '/images/load', optionsArg.tarStream);
return response;
}
public static async tagImageByIdOrName( public static async tagImageByIdOrName(
dockerHost: DockerHost, dockerHost: DockerHost,
idOrNameArg: string, idOrNameArg: string,
@ -126,7 +141,9 @@ export class DockerImage {
*/ */
public async pullLatestImageFromRegistry(): Promise<boolean> { public async pullLatestImageFromRegistry(): Promise<boolean> {
const updatedImage = await DockerImage.createFromRegistry(this.dockerHost, { const updatedImage = await DockerImage.createFromRegistry(this.dockerHost, {
creationObject: {
imageUrl: this.RepoTags[0], imageUrl: this.RepoTags[0],
},
}); });
Object.assign(this, updatedImage); Object.assign(this, updatedImage);
// TODO: Compare image digists before and after // TODO: Compare image digists before and after
@ -141,4 +158,33 @@ export class DockerImage {
return '0.0.0'; return '0.0.0';
} }
} }
/**
* exports an image to a tar ball
*/
public async exportToTarStream(): Promise<plugins.smartstream.stream.Readable> {
console.log(`Exporting image ${this.RepoTags[0]} to tar stream.`);
const response = await this.dockerHost.requestStreaming('GET', `/images/${encodeURIComponent(this.RepoTags[0])}/get`);
let counter = 0;
const webduplexStream = new plugins.smartstream.SmartDuplex({
writeFunction: async (chunk, tools) => {
if (counter % 1000 === 0)
console.log(`Got chunk: ${counter}`);
counter++;
return chunk;
}
});
response.on('data', (chunk) => {
if (!webduplexStream.write(chunk)) {
response.pause();
webduplexStream.once('drain', () => {
response.resume();
})
};
});
response.on('end', () => {
webduplexStream.end();
})
return webduplexStream;
}
} }

48
ts/classes.imagestore.ts Normal file
View File

@ -0,0 +1,48 @@
import * as plugins from './plugins.js';
import * as paths from './paths.js';
import type { DockerHost } from './classes.host.js';
export interface IDockerImageStoreConstructorOptions {
/**
* used for preparing images for longer term storage
*/
localDirPath: string;
/**
* a smartbucket dir for longer term storage.
*/
bucketDir: plugins.smartbucket.Directory;
}
export class DockerImageStore {
public options: IDockerImageStoreConstructorOptions;
constructor(dockerHost: DockerHost, optionsArg: IDockerImageStoreConstructorOptions) {
this.options = optionsArg;
}
// Method to store tar stream
public async storeImage(imageName: string, tarStream: plugins.smartstream.stream.Readable): Promise<void> {
const imagePath = plugins.path.join(this.options.localDirPath, `${imageName}.tar`);
// Create a write stream to store the tar file
const writeStream = plugins.smartfile.fsStream.createWriteStream(imagePath);
return new Promise((resolve, reject) => {
tarStream.pipe(writeStream);
writeStream.on('finish', resolve);
writeStream.on('error', reject);
});
}
// Method to retrieve tar stream
public async getImage(imageName: string): Promise<plugins.smartstream.stream.Readable> {
const imagePath = plugins.path.join(this.options.localDirPath, `${imageName}.tar`);
if (!(await plugins.smartfile.fs.fileExists(imagePath))) {
throw new Error(`Image ${imageName} does not exist.`);
}
return plugins.smartfile.fsStream.createReadStream(imagePath);
}
}

View File

@ -1,9 +1,9 @@
import * as plugins from './docker.plugins.js'; import * as plugins from './plugins.js';
import * as interfaces from './interfaces/index.js'; import * as interfaces from './interfaces/index.js';
import { DockerHost } from './docker.classes.host.js'; import { DockerHost } from './classes.host.js';
import { DockerService } from './docker.classes.service.js'; import { DockerService } from './classes.service.js';
import { logger } from './docker.logging.js'; import { logger } from './logging.js';
export class DockerNetwork { export class DockerNetwork {
public static async getNetworks(dockerHost: DockerHost): Promise<DockerNetwork[]> { public static async getNetworks(dockerHost: DockerHost): Promise<DockerNetwork[]> {

View File

@ -1,5 +1,5 @@
import * as plugins from './docker.plugins.js'; import * as plugins from './plugins.js';
import { DockerHost } from './docker.classes.host.js'; import { DockerHost } from './classes.host.js';
// interfaces // interfaces
import * as interfaces from './interfaces/index.js'; import * as interfaces from './interfaces/index.js';

View File

@ -1,10 +1,10 @@
import * as plugins from './docker.plugins.js'; import * as plugins from './plugins.js';
import * as interfaces from './interfaces/index.js'; import * as interfaces from './interfaces/index.js';
import { DockerHost } from './docker.classes.host.js'; import { DockerHost } from './classes.host.js';
import { DockerImage } from './docker.classes.image.js'; import { DockerImage } from './classes.image.js';
import { DockerSecret } from './docker.classes.secret.js'; import { DockerSecret } from './classes.secret.js';
import { logger } from './docker.logging.js'; import { logger } from './logging.js';
export class DockerService { export class DockerService {
// STATIC // STATIC
@ -232,7 +232,9 @@ export class DockerService {
await this.reReadFromDockerEngine(); await this.reReadFromDockerEngine();
const dockerImage = await DockerImage.createFromRegistry(this.dockerHostRef, { const dockerImage = await DockerImage.createFromRegistry(this.dockerHostRef, {
creationObject: {
imageUrl: this.Spec.TaskTemplate.ContainerSpec.Image, imageUrl: this.Spec.TaskTemplate.ContainerSpec.Image,
}
}); });
const imageVersion = new plugins.smartversion.SmartVersion(dockerImage.Labels.version); const imageVersion = new plugins.smartversion.SmartVersion(dockerImage.Labels.version);

View File

@ -1,6 +1,7 @@
export * from './docker.classes.host.js'; export * from './classes.host.js';
export * from './docker.classes.container.js'; export * from './classes.container.js';
export * from './docker.classes.image.js'; export * from './classes.image.js';
export * from './docker.classes.network.js'; export * from './classes.imagestore.js';
export * from './docker.classes.secret.js'; export * from './classes.network.js';
export * from './docker.classes.service.js'; export * from './classes.secret.js';
export * from './classes.service.js';

View File

@ -1,4 +1,4 @@
import { DockerNetwork } from '../docker.classes.network.js'; import { DockerNetwork } from '../classes.network.js';
export interface IContainerCreationDescriptor { export interface IContainerCreationDescriptor {
Hostname: string; Hostname: string;

View File

@ -1,9 +1,9 @@
import * as plugins from '../docker.plugins.js'; import * as plugins from '../plugins.js';
import * as interfaces from './index.js'; import * as interfaces from './index.js';
import { DockerNetwork } from '../docker.classes.network.js'; import { DockerNetwork } from '../classes.network.js';
import { DockerSecret } from '../docker.classes.secret.js'; import { DockerSecret } from '../classes.secret.js';
import { DockerImage } from '../docker.classes.image.js'; import { DockerImage } from '../classes.image.js';
export interface IServiceCreationDescriptor { export interface IServiceCreationDescriptor {
name: string; name: string;

View File

@ -1,3 +1,3 @@
import * as plugins from './docker.plugins.js'; import * as plugins from './plugins.js';
export const logger = new plugins.smartlog.ConsoleLog(); export const logger = new plugins.smartlog.ConsoleLog();

9
ts/paths.ts Normal file
View File

@ -0,0 +1,9 @@
import * as plugins from './plugins.js';
export const packageDir = plugins.path.resolve(
plugins.smartpath.get.dirnameFromImportMetaUrl(import.meta.url),
'../'
);
export const nogitDir = plugins.path.resolve(packageDir, '.nogit/');
plugins.smartfile.fs.ensureDir(nogitDir);

View File

@ -5,6 +5,7 @@ export { path };
// @pushrocks scope // @pushrocks scope
import * as lik from '@push.rocks/lik'; import * as lik from '@push.rocks/lik';
import * as smartbucket from '@push.rocks/smartbucket';
import * as smartfile from '@push.rocks/smartfile'; import * as smartfile from '@push.rocks/smartfile';
import * as smartjson from '@push.rocks/smartjson'; import * as smartjson from '@push.rocks/smartjson';
import * as smartlog from '@push.rocks/smartlog'; import * as smartlog from '@push.rocks/smartlog';
@ -13,10 +14,12 @@ import * as smartpath from '@push.rocks/smartpath';
import * as smartpromise from '@push.rocks/smartpromise'; import * as smartpromise from '@push.rocks/smartpromise';
import * as smartrequest from '@push.rocks/smartrequest'; import * as smartrequest from '@push.rocks/smartrequest';
import * as smartstring from '@push.rocks/smartstring'; import * as smartstring from '@push.rocks/smartstring';
import * as smartstream from '@push.rocks/smartstream';
import * as smartversion from '@push.rocks/smartversion'; import * as smartversion from '@push.rocks/smartversion';
export { export {
lik, lik,
smartbucket,
smartfile, smartfile,
smartjson, smartjson,
smartlog, smartlog,
@ -25,6 +28,7 @@ export {
smartpromise, smartpromise,
smartrequest, smartrequest,
smartstring, smartstring,
smartstream,
smartversion, smartversion,
}; };