Compare commits

..

40 Commits

Author SHA1 Message Date
3a4f59ef9e 1.0.95 2020-09-30 16:27:43 +00:00
90eac3e50a fix(core): update 2020-09-30 16:27:43 +00:00
edec48529d 1.0.94 2020-03-23 00:17:15 +00:00
e622b97097 fix(core): update 2020-03-23 00:17:15 +00:00
23266ca459 1.0.93 2020-03-23 00:01:46 +00:00
a91e69b6db fix(core): update 2020-03-23 00:01:45 +00:00
015ccfad48 1.0.92 2020-03-22 23:53:32 +00:00
06d2fcb750 fix(core): update 2020-03-22 23:53:31 +00:00
f3e4bc0350 1.0.91 2019-11-20 13:36:36 +00:00
6de3abe3bf fix(readme): update 2019-11-20 13:36:36 +00:00
eaa4140f2f 1.0.90 2019-11-20 13:36:04 +00:00
b21fe80109 fix(structure): formatted, ci updates and new readme 2019-11-20 13:36:03 +00:00
96a2992432 1.0.89 2019-11-20 13:27:18 +00:00
870b5f2c07 fix(dependencies): update smartnetwork 2019-11-20 13:27:17 +00:00
212edf1db7 1.0.88 2019-11-19 18:45:10 +00:00
46dbd81bcc fix(dependencies): update 2019-11-19 18:45:09 +00:00
8f5678502d 1.0.87 2019-11-19 18:42:16 +00:00
959d7aaed1 fix(core): update 2019-11-19 18:42:15 +00:00
5aa10653b6 1.0.86 2019-10-05 15:59:37 +02:00
e120d6527e fix(core): update 2019-10-05 15:59:36 +02:00
c80da05fbb 1.0.85 2019-10-05 15:56:49 +02:00
b9c3475b86 fix(core): update 2019-10-05 15:56:46 +02:00
de2d7e647b 1.0.84 2019-09-24 20:20:37 +02:00
d9348bd016 fix(Image().getVersion()): now returns 0.0.0 for unavailable versions to make SemVer work later on 2019-09-24 20:20:37 +02:00
034fbc3994 1.0.83 2019-09-23 13:52:52 +02:00
a33a6a1f7f fix(core): update 2019-09-23 13:52:52 +02:00
9dd403821b 1.0.82 2019-09-23 13:41:06 +02:00
601d82ea74 fix(core): update 2019-09-23 13:41:06 +02:00
784bb22511 1.0.81 2019-09-22 23:42:30 +02:00
71c89ac9bc fix(core): update 2019-09-22 23:42:29 +02:00
0b3e3b68c9 1.0.80 2019-09-22 17:42:29 +02:00
f3779faaaf fix(core): update 2019-09-22 17:42:28 +02:00
73476c2c39 1.0.79 2019-09-22 17:03:53 +02:00
942f65268d fix(core): update 2019-09-22 17:03:53 +02:00
a965647c1f 1.0.78 2019-09-22 15:11:57 +02:00
db88c7f86c fix(core): update 2019-09-22 15:11:57 +02:00
3f18cb68bf 1.0.77 2019-09-22 15:02:29 +02:00
dae3b59e3b fix(core): update 2019-09-22 15:02:29 +02:00
53062e70d4 1.0.76 2019-09-22 14:32:48 +02:00
3e70dc465b fix(core): update 2019-09-22 14:32:48 +02:00
16 changed files with 10249 additions and 1049 deletions

4
.gitignore vendored
View File

@ -15,8 +15,6 @@ node_modules/
# builds # builds
dist/ dist/
dist_web/ dist_*/
dist_serve/
dist_ts_web/
# custom # custom

View File

@ -4,13 +4,13 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache: cache:
paths: paths:
- .npmci_cache/ - .npmci_cache/
key: "$CI_BUILD_STAGE" key: '$CI_BUILD_STAGE'
stages: stages:
- security - security
- test - test
- release - release
- metadata - metadata
# ==================== # ====================
# security stage # security stage
@ -20,17 +20,20 @@ mirror:
script: script:
- npmci git mirror - npmci git mirror
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
snyk: audit:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci npm prepare - npmci npm prepare
- npmci command npm install -g snyk
- npmci command npm install --ignore-scripts - npmci command npm install --ignore-scripts
- npmci command snyk test - npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
@ -47,6 +50,7 @@ testStable:
- npmci npm test - npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- lossless
- docker - docker
- priv - priv
@ -59,6 +63,7 @@ testBuild:
- npmci command npm run build - npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
@ -70,6 +75,7 @@ release:
only: only:
- tags - tags
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
@ -81,9 +87,11 @@ codequality:
allow_failure: true allow_failure: true
script: script:
- npmci command npm install -g tslint typescript - npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install - npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts" - npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags: tags:
- lossless
- docker - docker
- priv - priv
@ -94,20 +102,20 @@ trigger:
only: only:
- tags - tags
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
pages: pages:
image: hosttoday/ht-docker-dbase:npmci
services:
- docker:stable-dind
stage: metadata stage: metadata
script: script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc - npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare - npmci npm prepare
- npmci npm install - npmci npm install
- npmci command tsdoc - npmci command tsdoc
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
only: only:

9
.snyk Normal file
View File

@ -0,0 +1,9 @@
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
version: v1.13.5
# ignores vulnerabilities until expiry date; change duration by modifying expiry date
ignore:
SNYK-JS-HTTPSPROXYAGENT-469131:
- '@pushrocks/smartnetwork > speedtest-net > https-proxy-agent':
reason: None given
expires: '2019-11-04T13:59:28.695Z'
patch: {}

26
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,26 @@
{
"json.schemas": [
{
"fileMatch": ["/npmextra.json"],
"schema": {
"type": "object",
"properties": {
"npmci": {
"type": "object",
"description": "settings for npmci"
},
"gitzone": {
"type": "object",
"description": "settings for gitzone",
"properties": {
"projectType": {
"type": "string",
"enum": ["website", "element", "service", "npm"]
}
}
}
}
}
}
]
}

View File

@ -10,6 +10,7 @@
"npmRegistryUrl": "registry.npmjs.org" "npmRegistryUrl": "registry.npmjs.org"
}, },
"gitzone": { "gitzone": {
"projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "mojoio", "gitscope": "mojoio",

10978
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,10 +1,10 @@
{ {
"name": "@mojoio/docker", "name": "@mojoio/docker",
"version": "1.0.75", "version": "1.0.95",
"description": "easy communication with docker remote api from node, TypeScript ready", "description": "easy communication with docker remote api from node, TypeScript ready",
"private": false, "private": false,
"main": "dist/index.js", "main": "dist_ts/index.js",
"typings": "dist/index.d.ts", "typings": "dist_ts/index.d.ts",
"scripts": { "scripts": {
"test": "tstest test/", "test": "tstest test/",
"build": "tsbuild" "build": "tsbuild"
@ -27,34 +27,36 @@
}, },
"homepage": "https://gitlab.com/pushrocks/dockersock#README", "homepage": "https://gitlab.com/pushrocks/dockersock#README",
"dependencies": { "dependencies": {
"@pushrocks/lik": "^3.0.11", "@pushrocks/lik": "^4.0.17",
"@pushrocks/smartfile": "^7.0.4", "@pushrocks/smartfile": "^8.0.0",
"@pushrocks/smartjson": "^3.0.8", "@pushrocks/smartjson": "^3.0.10",
"@pushrocks/smartlog": "^2.0.19", "@pushrocks/smartlog": "^2.0.39",
"@pushrocks/smartnetwork": "^1.1.14", "@pushrocks/smartnetwork": "^1.1.22",
"@pushrocks/smartpath": "^4.0.1", "@pushrocks/smartpath": "^4.0.3",
"@pushrocks/smartpromise": "^3.0.2", "@pushrocks/smartpromise": "^3.0.6",
"@pushrocks/smartrequest": "^1.1.26", "@pushrocks/smartrequest": "^1.1.51",
"@pushrocks/smartstring": "^3.0.10", "@pushrocks/smartstring": "^3.0.18",
"@pushrocks/smartversion": "^2.0.4", "@pushrocks/smartversion": "^2.0.4",
"rxjs": "^6.5.3" "@tsclass/tsclass": "^3.0.25",
"rxjs": "^6.6.3"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.17", "@gitzone/tsbuild": "^2.1.25",
"@gitzone/tsrun": "^1.2.8", "@gitzone/tsrun": "^1.2.12",
"@gitzone/tstest": "^1.0.24", "@gitzone/tstest": "^1.0.48",
"@pushrocks/tapbundle": "^3.0.13", "@pushrocks/tapbundle": "^3.2.9",
"@types/node": "^12.7.4", "@types/node": "^14.11.2",
"tslint": "^5.19.0", "tslint": "^6.1.3",
"tslint-config-prettier": "^1.18.0" "tslint-config-prettier": "^1.18.0"
}, },
"files": [ "files": [
"ts/*", "ts/**/*",
"ts_web/*", "ts_web/**/*",
"dist/*", "dist/**/*",
"dist_web/*", "dist_*/**/*",
"dist_ts_web/*", "dist_ts/**/*",
"assets/*", "dist_ts_web/**/*",
"assets/**/*",
"cli.js", "cli.js",
"npmextra.json", "npmextra.json",
"readme.md" "readme.md"

View File

@ -8,7 +8,7 @@ unofficial docker engine api abstraction package written in TypeScript
* [docs (typedoc)](https://mojoio.gitlab.io/docker/) * [docs (typedoc)](https://mojoio.gitlab.io/docker/)
## Status for master ## Status for master
[![build status](https://gitlab.com/mojoio/docker/badges/master/build.svg)](https://gitlab.com/mojoio/docker/commits/master) [![pipeline status](https://gitlab.com/mojoio/docker/badges/master/pipeline.svg)](https://gitlab.com/mojoio/docker/commits/master)
[![coverage report](https://gitlab.com/mojoio/docker/badges/master/coverage.svg)](https://gitlab.com/mojoio/docker/commits/master) [![coverage report](https://gitlab.com/mojoio/docker/badges/master/coverage.svg)](https://gitlab.com/mojoio/docker/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@mojoio/docker.svg)](https://www.npmjs.com/package/@mojoio/docker) [![npm downloads per month](https://img.shields.io/npm/dm/@mojoio/docker.svg)](https://www.npmjs.com/package/@mojoio/docker)
[![Known Vulnerabilities](https://snyk.io/test/npm/@mojoio/docker/badge.svg)](https://snyk.io/test/npm/@mojoio/docker) [![Known Vulnerabilities](https://snyk.io/test/npm/@mojoio/docker/badge.svg)](https://snyk.io/test/npm/@mojoio/docker)
@ -30,6 +30,10 @@ const run = async () => {
}; };
``` ```
## Contribution
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). :)
For further information read the linked docs at the top of this readme. For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

View File

@ -2,6 +2,7 @@ import * as plugins from './docker.plugins';
import * as interfaces from './interfaces'; import * as interfaces from './interfaces';
import { DockerHost } from './docker.classes.host'; import { DockerHost } from './docker.classes.host';
import { logger } from './docker.logging';
export class DockerContainer { export class DockerContainer {
// STATIC // STATIC
@ -47,9 +48,9 @@ export class DockerContainer {
User: 'root' User: 'root'
}); });
if (response.statusCode < 300) { if (response.statusCode < 300) {
plugins.smartlog.defaultLogger.log('info', 'Container created successfully'); logger.log('info', 'Container created successfully');
} else { } else {
plugins.smartlog.defaultLogger.log( logger.log(
'error', 'error',
'There has been a problem when creating the container' 'There has been a problem when creating the container'
); );

View File

@ -2,6 +2,7 @@ import * as plugins from './docker.plugins';
import { DockerContainer } from './docker.classes.container'; import { DockerContainer } from './docker.classes.container';
import { DockerNetwork } from './docker.classes.network'; import { DockerNetwork } from './docker.classes.network';
import { DockerService } from './docker.classes.service'; import { DockerService } from './docker.classes.service';
import { logger } from './docker.logging';
export interface IAuthData { export interface IAuthData {
serveraddress: string; serveraddress: string;
@ -138,9 +139,9 @@ export class DockerHost {
ForceNewCluster: false ForceNewCluster: false
}); });
if (response.statusCode === 200) { if (response.statusCode === 200) {
plugins.smartlog.defaultLogger.log('info', 'created Swam succesfully'); logger.log('info', 'created Swam succesfully');
} else { } else {
plugins.smartlog.defaultLogger.log('error', 'could not initiate swarm'); logger.log('error', 'could not initiate swarm');
} }
} }

View File

@ -1,6 +1,7 @@
import * as plugins from './docker.plugins'; import * as plugins from './docker.plugins';
import * as interfaces from './interfaces'; import * as interfaces from './interfaces';
import { DockerHost } from './docker.classes.host'; import { DockerHost } from './docker.classes.host';
import { logger } from './docker.logging';
export class DockerImage { export class DockerImage {
// STATIC // STATIC
@ -63,14 +64,14 @@ export class DockerImage {
)}&tag=${encodeURIComponent(imageUrlObject.imageTag)}` )}&tag=${encodeURIComponent(imageUrlObject.imageTag)}`
); );
if (response.statusCode < 300) { if (response.statusCode < 300) {
plugins.smartlog.defaultLogger.log( logger.log(
'info', 'info',
`Successfully pulled image ${imageUrlObject.imageUrl} from the registry` `Successfully pulled image ${imageUrlObject.imageUrl} from the registry`
); );
const image = await DockerImage.findImageByName(dockerHostArg, imageUrlObject.imageOriginTag); const image = await DockerImage.findImageByName(dockerHostArg, imageUrlObject.imageOriginTag);
return image; return image;
} else { } else {
plugins.smartlog.defaultLogger.log('error', `Failed at the attempt of creating a new image`); logger.log('error', `Failed at the attempt of creating a new image`);
} }
} }
@ -140,7 +141,7 @@ export class DockerImage {
if (this.Labels && this.Labels.version) { if (this.Labels && this.Labels.version) {
return this.Labels.version; return this.Labels.version;
} else { } else {
return 'x.x.x'; return '0.0.0';
} }
} }
} }

View File

@ -2,6 +2,8 @@ import * as plugins from './docker.plugins';
import * as interfaces from './interfaces'; import * as interfaces from './interfaces';
import { DockerHost } from './docker.classes.host'; import { DockerHost } from './docker.classes.host';
import { DockerService } from './docker.classes.service';
import { logger } from './docker.logging';
export class DockerNetwork { export class DockerNetwork {
public static async getNetworks(dockerHost: DockerHost): Promise<DockerNetwork[]> { public static async getNetworks(dockerHost: DockerHost): Promise<DockerNetwork[]> {
@ -29,25 +31,25 @@ export class DockerNetwork {
CheckDuplicate: true, CheckDuplicate: true,
Driver: 'overlay', Driver: 'overlay',
EnableIPv6: false, EnableIPv6: false,
IPAM: { /* IPAM: {
Driver: 'default', Driver: 'default',
Config: [ Config: [
{ {
Subnet: '172.20.10.0/16', Subnet: `172.20.${networkCreationDescriptor.NetworkNumber}.0/16`,
IPRange: '172.20.10.0/24', IPRange: `172.20.${networkCreationDescriptor.NetworkNumber}.0/24`,
Gateway: '172.20.10.11' Gateway: `172.20.${networkCreationDescriptor.NetworkNumber}.11`
} }
] ]
}, }, */
Internal: true, Internal: false,
Attachable: true, Attachable: true,
Ingress: false Ingress: false
}); });
if (response.statusCode < 300) { if (response.statusCode < 300) {
plugins.smartlog.defaultLogger.log('info', 'Created network successfully'); logger.log('info', 'Created network successfully');
return await DockerNetwork.getNetworkByName(dockerHost, networkCreationDescriptor.Name); return await DockerNetwork.getNetworkByName(dockerHost, networkCreationDescriptor.Name);
} else { } else {
plugins.smartlog.defaultLogger.log( logger.log(
'error', 'error',
'There has been an error creating the wanted network' 'There has been an error creating the wanted network'
); );
@ -91,16 +93,29 @@ export class DockerNetwork {
const response = await this.dockerHost.request('DELETE', `/networks/${this.Id}`); const response = await this.dockerHost.request('DELETE', `/networks/${this.Id}`);
} }
public async getContainersOnNetwork(): Promise<{ public async getContainersOnNetwork(): Promise<
[key: string]: { Array<{
Name: string; Name: string;
EndpointID: string; EndpointID: string;
MacAddress: string; MacAddress: string;
IPv4Address: string; IPv4Address: string;
IPv6Address: string; IPv6Address: string;
}; }>
}> { > {
const returnArray = [];
const response = await this.dockerHost.request('GET', `/networks/${this.Id}`); const response = await this.dockerHost.request('GET', `/networks/${this.Id}`);
return response.body.Containers; for (const key of Object.keys(response.body.Containers)) {
returnArray.push(response.body.Containers[key]);
}
return returnArray;
}
public async getContainersOnNetworkForService(serviceArg: DockerService) {
const containersOnNetwork = await this.getContainersOnNetwork();
const containersOfService = containersOnNetwork.filter(container => {
return container.Name.startsWith(serviceArg.Spec.Name);
});
return containersOfService;
} }
} }

View File

@ -4,6 +4,7 @@ import * as interfaces from './interfaces';
import { DockerHost } from './docker.classes.host'; import { DockerHost } from './docker.classes.host';
import { DockerImage } from './docker.classes.image'; import { DockerImage } from './docker.classes.image';
import { DockerSecret } from './docker.classes.secret'; import { DockerSecret } from './docker.classes.secret';
import { logger } from './docker.logging';
export class DockerService { export class DockerService {
// STATIC // STATIC
@ -37,7 +38,7 @@ export class DockerService {
serviceCreationDescriptor: interfaces.IServiceCreationDescriptor serviceCreationDescriptor: interfaces.IServiceCreationDescriptor
): Promise<DockerService> { ): Promise<DockerService> {
// lets get the image // lets get the image
plugins.smartlog.defaultLogger.log( logger.log(
'info', 'info',
`now creating service ${serviceCreationDescriptor.name}` `now creating service ${serviceCreationDescriptor.name}`
); );
@ -73,6 +74,18 @@ export class DockerService {
}); });
} }
if (serviceCreationDescriptor.resources && serviceCreationDescriptor.resources.volumeMounts) {
for(const volumeMount of serviceCreationDescriptor.resources.volumeMounts) {
mounts.push({
Target: volumeMount.containerFsPath,
Source: volumeMount.hostFsPath,
Consistency: 'default',
ReadOnly: false,
Type: 'bind'
});
}
}
const networkArray: Array<{ const networkArray: Array<{
Target: string; Target: string;
Aliases: string[]; Aliases: string[];
@ -113,8 +126,14 @@ export class DockerService {
} }
// lets configure limits // lets configure limits
const memoryLimitMB =
serviceCreationDescriptor.resources && serviceCreationDescriptor.resources.memorySizeMB
? serviceCreationDescriptor.resources.memorySizeMB
: 1000;
const limits = { const limits = {
MemoryBytes: 1000 * 1000000 MemoryBytes: memoryLimitMB * 1000000
}; };
if (serviceCreationDescriptor.resources) { if (serviceCreationDescriptor.resources) {
@ -129,6 +148,9 @@ export class DockerService {
Labels: labels, Labels: labels,
Secrets: secretArray, Secrets: secretArray,
Mounts: mounts Mounts: mounts
/* DNSConfig: {
Nameservers: ['1.1.1.1']
} */
}, },
UpdateConfig: { UpdateConfig: {
Parallelism: 0, Parallelism: 0,
@ -140,6 +162,13 @@ export class DockerService {
ForceUpdate: 1, ForceUpdate: 1,
Resources: { Resources: {
Limits: limits Limits: limits
},
LogDriver: {
Name: 'json-file',
Options: {
'max-file': '3',
'max-size': '10M'
}
} }
}, },
Labels: labels, Labels: labels,

3
ts/docker.logging.ts Normal file
View File

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

View File

@ -15,8 +15,6 @@ import * as smartrequest from '@pushrocks/smartrequest';
import * as smartstring from '@pushrocks/smartstring'; import * as smartstring from '@pushrocks/smartstring';
import * as smartversion from '@pushrocks/smartversion'; import * as smartversion from '@pushrocks/smartversion';
smartlog.defaultLogger.enableConsole();
export { export {
lik, lik,
smartfile, smartfile,
@ -30,6 +28,13 @@ export {
smartversion smartversion
}; };
// @tsclass scope
import * as tsclass from '@tsclass/tsclass';
export {
tsclass
};
// third party // third party
import * as rxjs from 'rxjs'; import * as rxjs from 'rxjs';

View File

@ -1,3 +1,5 @@
import * as plugins from '../docker.plugins';
import * as interfaces from './'; import * as interfaces from './';
import { DockerNetwork } from '../docker.classes.network'; import { DockerNetwork } from '../docker.classes.network';
import { DockerSecret } from '../docker.classes.secret'; import { DockerSecret } from '../docker.classes.secret';
@ -13,6 +15,7 @@ export interface IServiceCreationDescriptor {
ports: string[]; ports: string[];
accessHostDockerSock?: boolean; accessHostDockerSock?: boolean;
resources?: { resources?: {
memorySizeMB: number memorySizeMB?: number;
volumeMounts?: plugins.tsclass.container.IVolumeMount[]
}; };
} }