@lakutata/containerd 0.0.0-stage → 3.0.0-beta.0

package/dist/cjs/client/Networks.d.ts

@@ -0,0 +1,221 @@
+/**
+ * A network of CNI (a configuration list of /etc/cni/net.d): the ones of nerdctl, the others of the machine
+ */
+export type CNINetwork = {
+    name: string;
+    /**
+     * Its identifier (the one of nerdctl, or the digest of its name)
+     */
+    id: string;
+    /**
+     * Its configuration list
+     */
+    file: string;
+    labels: Record<string, string>;
+    cniVersion: string;
+    /**
+     * The type of its first plugin (bridge, macvlan, ipvlan…)
+     */
+    driver: string;
+    subnets: string[];
+    gateways: string[];
+    plugins: Record<string, any>[];
+    /**
+     * Created by nerdctl (or by this package): removable
+     */
+    managed: boolean;
+};
+/**
+ * The options of the creation of a network
+ */
+export type CNINetworkCreateOptions = {
+    name: string;
+    driver?: 'bridge' | 'macvlan' | 'ipvlan';
+    /**
+     * Its subnet (CIDR of IPv4), a free one of 10.4.0.0/16 by default
+     */
+    subnet?: string;
+    gateway?: string;
+    /**
+     * The range of its addresses given to the containers (CIDR in its subnet)
+     */
+    ipRange?: string;
+    /**
+     * The interface of the host of a macvlan or ipvlan network
+     */
+    parent?: string;
+    /**
+     * Without the gateway and the masquerade of the host (bridge)
+     */
+    internal?: boolean;
+    mtu?: number;
+    labels?: Record<string, string>;
+    /**
+     * Its subnet of IPv6 (CIDR), besides its subnet of IPv4
+     */
+    ipv6Subnet?: string;
+    /**
+     * Its gateway of IPv6, the first address of its subnet by default
+     */
+    ipv6Gateway?: string;
+};
+/**
+ * A port of a container published on the host
+ */
+export type PortMapping = {
+    hostPort: number;
+    containerPort: number;
+    protocol: 'tcp' | 'udp' | 'sctp';
+    hostIP?: string;
+};
+/**
+ * An interface of a container on a network (its result of CNI)
+ */
+export type ContainerNetworkInterface = {
+    network: string;
+    interface: string;
+    mac?: string;
+    ip?: string;
+    prefixLength?: number;
+    gateway?: string;
+    ipv6?: string;
+    ipv6Gateway?: string;
+};
+/**
+ * A network of a container asked: its name, its address
+ */
+export type ContainerNetworkRequest = {
+    name: string;
+    ip?: string;
+    ipv6?: string;
+};
+/**
+ * The default network of nerdctl
+ */
+export declare const DEFAULT_NETWORK: string;
+/**
+ * The script of the networks of the containers, run by runc as their hooks: add (createRuntime, the networks of CNI
+ * added to the namespace of the container, its /etc/hosts given its address), del (poststop, the networks deleted, their
+ * addresses released). The plugins of each network are chained as libcni chains them (the result of each one is the
+ * previous result of the next one); their configurations are the files written for the container
+ */
+export declare const HOOK_SCRIPT: string;
+/**
+ * The first and the last addresses of a subnet (CIDR of IPv4)
+ * @param cidr
+ */
+export declare function parseSubnet(cidr: string): {
+    network: number;
+    broadcast: number;
+    prefix: number;
+    cidr: string;
+};
+/**
+ * A subnet of IPv6 (CIDR): its network, its prefix, its first address
+ * @param cidr
+ */
+export declare function parseIPv6Subnet(cidr: string): {
+    cidr: string;
+    first: string;
+    network: bigint;
+    last: bigint;
+};
+/**
+ * The networks of CNI of the machine (the configuration lists of its directory), the ones of nerdctl created and
+ * removed, the configurations of the networks of the containers written for their hooks
+ */
+export declare class NetworkStore {
+    #private;
+    readonly confDir: string;
+    readonly cniPath: string[];
+    constructor(confDir: string, cniPath: string[]);
+    /**
+     * The directories of the plugins which exist
+     */
+    pluginDirectories(): string[];
+    /**
+     * The path of a plugin, undefined when it is not installed
+     * @param type
+     */
+    plugin(type: string): string | undefined;
+    /**
+     * The version of CNI of the configurations written: the newest one of the plugins (1.0.0, or 0.4.0)
+     */
+    protected cniVersion(): string;
+    /**
+     * A network of a configuration list
+     * @param file
+     * @param content
+     */
+    protected parse(file: string, content: string): CNINetwork | undefined;
+    /**
+     * The networks of CNI of the machine
+     */
+    list(): Promise<CNINetwork[]>;
+    /**
+     * A network, by its name or its identifier (or a prefix of it); the default one of nerdctl created when it is asked
+     * @param nameOrId
+     */
+    get(nameOrId: string): Promise<CNINetwork | undefined>;
+    /**
+     * The plugins added after the main one, as nerdctl adds them (the ones installed)
+     * @param driver
+     * @protected
+     */
+    protected chainedPlugins(driver: string): Record<string, any>[];
+    /**
+     * Write a configuration list
+     * @param name
+     * @param id
+     * @param labels
+     * @param plugins
+     * @protected
+     */
+    protected write(name: string, id: string, labels: Record<string, string>, plugins: Record<string, any>[]): Promise<CNINetwork>;
+    /**
+     * Create the default network of nerdctl (bridge, nerdctl0, 10.4.0.0/24)
+     * @protected
+     */
+    protected createDefault(): Promise<CNINetwork>;
+    /**
+     * A free subnet of 10.4.0.0/16 (the ones of nerdctl)
+     * @param used
+     * @protected
+     */
+    protected freeSubnet(used: string[]): string;
+    /**
+     * Create a network (bridge, macvlan, ipvlan), as nerdctl network create does
+     * @param options
+     */
+    create(options: CNINetworkCreateOptions): Promise<CNINetwork>;
+    /**
+     * Remove a network (one of nerdctl): its configuration, its bridge and the rules of its firewall, the leases of its
+     * addresses, as nerdctl network rm does
+     * @param network
+     */
+    remove(network: CNINetwork): Promise<void>;
+    /**
+     * Write the configurations of the networks of a container for its hooks (the configurations of their plugins, their
+     * runtime configurations: the ports published on the first one)
+     * @param stateDir
+     * @param containerId
+     * @param networks
+     * @param ports
+     */
+    render(stateDir: string, containerId: string, networks: {
+        network: CNINetwork;
+        ip?: string;
+        ipv6?: string;
+    }[], ports: PortMapping[]): Promise<void>;
+    /**
+     * Delete the networks of a container whose hook did not (its task killed with its shim): the hook run as runc runs
+     * it
+     * @param stateDir
+     */
+    teardown(stateDir: string): Promise<void>;
+    /**
+     * The interfaces of a container on its networks (their results of CNI)
+     * @param stateDir
+     */
+    interfaces(stateDir: string): Promise<ContainerNetworkInterface[]>;
+}