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

Basic docker compose #282

Closed
wants to merge 6 commits into from
Closed

Basic docker compose #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3c2a826
start docker compose
leonitousconforti Nov 3, 2024
2d79510
initial implementation
leonitousconforti Nov 3, 2024
a34bbe0
docgen
leonitousconforti Nov 3, 2024
3dbc438
add docker compose example
leonitousconforti Nov 3, 2024
ae489e5
working
leonitousconforti Nov 4, 2024
9c4303c
fix example
leonitousconforti Nov 4, 2024
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
26 changes: 12 additions & 14 deletions docs/modules/engines/Dind.ts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export declare const makeDindLayerFromPlatformConstructor: <
PlatformLayerConstructor extends (
connectionOptions: any
) => Layer.Layer<Layer.Layer.Success<DockerEngine.DockerLayer>, unknown, unknown>,
SupportedConnectionOptions extends Platforms.MobyConnectionOptions = PlatformLayerConstructor extends (
SupportedConnectionOptions extends MobyConnectionOptions = PlatformLayerConstructor extends (
connectionOptions: infer C
) => Layer.Layer<Layer.Layer.Success<DockerEngine.DockerLayer>, infer _E, infer _R>
? C
Expand All @@ -66,7 +66,7 @@ export type MakeDindLayerFromPlatformConstructor<
// eslint-disable-next-line @typescript-eslint/no-explicit-any
connectionOptions: any
) => Layer.Layer<Layer.Layer.Success<DockerEngine.DockerLayer>, unknown, unknown>,
SupportedConnectionOptions extends Platforms.MobyConnectionOptions = PlatformLayerConstructor extends (
SupportedConnectionOptions extends MobyConnectionOptions = PlatformLayerConstructor extends (
connectionOptions: infer C
) => Layer.Layer<Layer.Layer.Success<DockerEngine.DockerLayer>, infer _E, infer _R>
? C
Expand All @@ -91,12 +91,12 @@ export type MakeDindLayerFromPlatformConstructor<
>(options: {
exposeDindContainerBy: ConnectionOptionsToDind
connectionOptionsToHost: ConnectionOptionsToHost
dindBaseImage: BlobConstants.RecommendedDindBaseImages
dindBaseImage: RecommendedDindBaseImages
}) => Layer.Layer<
Layer.Layer.Success<DockerEngine.DockerLayer>,
| Images.ImagesError
| System.SystemsError
| Volumes.VolumesError
| ImagesError
| SystemsError
| VolumesError
| ParseResult.ParseError
| ContainersError
| PlatformLayerConstructorError
Expand All @@ -115,7 +115,7 @@ Added in v1.0.0
```ts
export declare const layerAgnostic: MakeDindLayerFromPlatformConstructor<
(
connectionOptions: Platforms.HttpConnectionOptionsTagged | Platforms.HttpsConnectionOptionsTagged
connectionOptions: HttpConnectionOptionsTagged | HttpsConnectionOptionsTagged
) => DockerEngine.DockerLayerWithoutHttpClient,
| { readonly _tag: "http"; readonly host: string; readonly port: number; readonly path?: string | undefined }
| {
Expand All @@ -141,7 +141,7 @@ Added in v1.0.0

```ts
export declare const layerBun: MakeDindLayerFromPlatformConstructor<
(connectionOptions: Platforms.MobyConnectionOptions) => DockerEngine.DockerLayer,
(connectionOptions: MobyConnectionOptions) => DockerEngine.DockerLayer,
| { readonly _tag: "socket"; readonly socketPath: string }
| {
readonly _tag: "ssh"
Expand Down Expand Up @@ -198,7 +198,7 @@ Added in v1.0.0

```ts
export declare const layerDeno: MakeDindLayerFromPlatformConstructor<
(connectionOptions: Platforms.MobyConnectionOptions) => DockerEngine.DockerLayer,
(connectionOptions: MobyConnectionOptions) => DockerEngine.DockerLayer,
| { readonly _tag: "socket"; readonly socketPath: string }
| {
readonly _tag: "ssh"
Expand Down Expand Up @@ -255,7 +255,7 @@ Added in v1.0.0

```ts
export declare const layerNodeJS: MakeDindLayerFromPlatformConstructor<
(connectionOptions: Platforms.MobyConnectionOptions) => DockerEngine.DockerLayer,
(connectionOptions: MobyConnectionOptions) => DockerEngine.DockerLayer,
| { readonly _tag: "socket"; readonly socketPath: string }
| {
readonly _tag: "ssh"
Expand Down Expand Up @@ -312,7 +312,7 @@ Added in v1.0.0

```ts
export declare const layerUndici: MakeDindLayerFromPlatformConstructor<
(connectionOptions: Platforms.MobyConnectionOptions) => DockerEngine.DockerLayer,
(connectionOptions: MobyConnectionOptions) => DockerEngine.DockerLayer,
| { readonly _tag: "socket"; readonly socketPath: string }
| {
readonly _tag: "ssh"
Expand Down Expand Up @@ -369,9 +369,7 @@ Added in v1.0.0

```ts
export declare const layerWeb: MakeDindLayerFromPlatformConstructor<
(
connectionOptions: Platforms.HttpConnectionOptionsTagged | Platforms.HttpsConnectionOptionsTagged
) => DockerEngine.DockerLayer,
(connectionOptions: HttpConnectionOptionsTagged | HttpsConnectionOptionsTagged) => DockerEngine.DockerLayer,
| { readonly _tag: "http"; readonly host: string; readonly port: number; readonly path?: string | undefined }
| {
readonly _tag: "https"
Expand Down
84 changes: 28 additions & 56 deletions docs/modules/engines/Docker.ts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export declare const build: <E1>({
dockerfile?: string | undefined
context: Stream.Stream<Uint8Array, E1, never>
buildArgs?: Record<string, string | undefined> | undefined
}) => Stream.Stream<GeneratedSchemas.JSONMessage, Images.ImagesError, Images.Images>
}) => Stream.Stream<JSONMessage, ImagesError, Images>
```

Added in v1.0.0
Expand Down Expand Up @@ -97,11 +97,7 @@ export declare const buildScoped: <E1>({
dockerfile?: string | undefined
buildArgs?: Record<string, string | undefined> | undefined
context: Stream.Stream<Uint8Array, E1, never>
}) => Effect.Effect<
Stream.Stream<GeneratedSchemas.JSONMessage, Images.ImagesError, Images.Images>,
Images.ImagesError,
Scope.Scope | Images.Images
>
}) => Effect.Effect<Stream.Stream<JSONMessage, ImagesError, Images>, ImagesError, Scope.Scope | Images>
```

Added in v1.0.0
Expand All @@ -119,7 +115,7 @@ export declare const exec: ({
}: {
containerId: string
command: Array<string>
}) => Effect.Effect<string, Execs.ExecsError | Socket.SocketError | ParseResult.ParseError, Execs.Execs>
}) => Effect.Effect<string, ExecsError | Socket.SocketError | ParseResult.ParseError, Execs>
```

Added in v1.0.0
Expand All @@ -137,7 +133,7 @@ export declare const execNonBlocking: ({
}: {
containerId: string
command: Array<string>
}) => Effect.Effect<void, Execs.ExecsError | Socket.SocketError | ParseResult.ParseError, Execs.Execs>
}) => Effect.Effect<void, ExecsError | Socket.SocketError | ParseResult.ParseError, Execs>
```

Added in v1.0.0
Expand All @@ -150,8 +146,8 @@ Implements the `docker images` command.

```ts
export declare const images: (
options?: Parameters<Images.Images["list"]>[0]
) => Effect.Effect<ReadonlyArray<GeneratedSchemas.ImageSummary>, Images.ImagesError, Images.Images>
options?: Parameters<Images["list"]>[0]
) => Effect.Effect<ReadonlyArray<ImageSummary>, ImagesError, Images>
```

Added in v1.0.0
Expand All @@ -163,11 +159,7 @@ Implements the `docker info` command.
**Signature**

```ts
export declare const info: () => Effect.Effect<
Readonly<GeneratedSchemas.SystemInfoResponse>,
System.SystemsError,
System.Systems
>
export declare const info: () => Effect.Effect<Readonly<SystemInfoResponse>, SystemsError, Systems>
```

Added in v1.0.0
Expand All @@ -179,7 +171,7 @@ Implements the `docker ping` command.
**Signature**

```ts
export declare const ping: () => Effect.Effect<"OK", System.SystemsError, System.Systems>
export declare const ping: () => Effect.Effect<"OK", SystemsError, Systems>
```

Added in v1.0.0
Expand All @@ -191,7 +183,7 @@ Implements the `docker ping` command.
**Signature**

```ts
export declare const pingHead: () => Effect.Effect<void, System.SystemsError, System.Systems>
export declare const pingHead: () => Effect.Effect<void, SystemsError, Systems>
```

Added in v1.0.0
Expand All @@ -204,12 +196,8 @@ Implements the `docker ps` command.

```ts
export declare const ps: (
options?: Parameters<Containers.Containers["list"]>[0]
) => Effect.Effect<
ReadonlyArray<GeneratedSchemas.ContainerListResponseItem>,
Containers.ContainersError,
Containers.Containers
>
options?: Parameters<Containers["list"]>[0]
) => Effect.Effect<ReadonlyArray<ContainerListResponseItem>, ContainersError, Containers>
```

Added in v1.0.0
Expand All @@ -230,7 +218,7 @@ export declare const pull: ({
image: string
auth?: string | undefined
platform?: string | undefined
}) => Stream.Stream<GeneratedSchemas.JSONMessage, Images.ImagesError, Images.Images>
}) => Stream.Stream<JSONMessage, ImagesError, Images>
```

Added in v1.0.0
Expand All @@ -252,11 +240,7 @@ export declare const pullScoped: ({
image: string
auth?: string | undefined
platform?: string | undefined
}) => Effect.Effect<
Stream.Stream<GeneratedSchemas.JSONMessage, Images.ImagesError, Images.Images>,
never,
Images.Images | Scope.Scope
>
}) => Effect.Effect<Stream.Stream<JSONMessage, ImagesError, Images>, never, Images | Scope.Scope>
```

Added in v1.0.0
Expand All @@ -268,9 +252,7 @@ Implements the `docker push` command.
**Signature**

```ts
export declare const push: (
options: Parameters<Images.Images["push"]>[0]
) => Stream.Stream<string, Images.ImagesError, Images.Images>
export declare const push: (options: Parameters<Images["push"]>[0]) => Stream.Stream<string, ImagesError, Images>
```

Added in v1.0.0
Expand All @@ -283,8 +265,8 @@ Implements `docker run` command.

```ts
export declare const run: (
containerOptions: Parameters<Containers.Containers["create"]>[0]
) => Effect.Effect<GeneratedSchemas.ContainerInspectResponse, Containers.ContainersError, Containers.Containers>
containerOptions: Parameters<Containers["create"]>[0]
) => Effect.Effect<ContainerInspectResponse, ContainersError, Containers>
```

Added in v1.0.0
Expand All @@ -298,12 +280,8 @@ both the image and the container is removed.

```ts
export declare const runScoped: (
containerOptions: Parameters<Containers.Containers["create"]>[0]
) => Effect.Effect<
GeneratedSchemas.ContainerInspectResponse,
Containers.ContainersError,
Scope.Scope | Containers.Containers
>
containerOptions: Parameters<Containers["create"]>[0]
) => Effect.Effect<ContainerInspectResponse, ContainersError, Scope.Scope | Containers>
```

Added in v1.0.0
Expand All @@ -316,8 +294,8 @@ Implements the `docker search` command.

```ts
export declare const search: (
options: Parameters<Images.Images["search"]>[0]
) => Effect.Effect<ReadonlyArray<GeneratedSchemas.RegistrySearchResponse>, Images.ImagesError, Images.Images>
options: Parameters<Images["search"]>[0]
) => Effect.Effect<ReadonlyArray<RegistrySearchResponse>, ImagesError, Images>
```

Added in v1.0.0
Expand All @@ -329,9 +307,7 @@ Implements the `docker stop` command.
**Signature**

```ts
export declare const stop: (
containerId: string
) => Effect.Effect<void, Containers.ContainersError, Containers.Containers>
export declare const stop: (containerId: string) => Effect.Effect<void, ContainersError, Containers>
```

Added in v1.0.0
Expand All @@ -343,11 +319,7 @@ Implements the `docker version` command.
**Signature**

```ts
export declare const version: () => Effect.Effect<
Readonly<GeneratedSchemas.SystemVersionResponse>,
System.SystemsError,
System.Systems
>
export declare const version: () => Effect.Effect<Readonly<SystemVersionResponse>, SystemsError, Systems>
```

Added in v1.0.0
Expand Down Expand Up @@ -380,7 +352,7 @@ Added in v1.0.0

```ts
export declare const layerAgnostic: (
connectionOptions: Platforms.HttpConnectionOptionsTagged | Platforms.HttpsConnectionOptionsTagged
connectionOptions: HttpConnectionOptionsTagged | HttpsConnectionOptionsTagged
) => DockerLayerWithoutHttpClient
```

Expand All @@ -391,7 +363,7 @@ Added in v1.0.0
**Signature**

```ts
export declare const layerBun: (connectionOptions: Platforms.MobyConnectionOptions) => DockerLayer
export declare const layerBun: (connectionOptions: MobyConnectionOptions) => DockerLayer
```

Added in v1.0.0
Expand All @@ -401,7 +373,7 @@ Added in v1.0.0
**Signature**

```ts
export declare const layerDeno: (connectionOptions: Platforms.MobyConnectionOptions) => DockerLayer
export declare const layerDeno: (connectionOptions: MobyConnectionOptions) => DockerLayer
```

Added in v1.0.0
Expand All @@ -411,7 +383,7 @@ Added in v1.0.0
**Signature**

```ts
export declare const layerNodeJS: (connectionOptions: Platforms.MobyConnectionOptions) => DockerLayer
export declare const layerNodeJS: (connectionOptions: MobyConnectionOptions) => DockerLayer
```

Added in v1.0.0
Expand All @@ -421,7 +393,7 @@ Added in v1.0.0
**Signature**

```ts
export declare const layerUndici: (connectionOptions: Platforms.MobyConnectionOptions) => DockerLayer
export declare const layerUndici: (connectionOptions: MobyConnectionOptions) => DockerLayer
```

Added in v1.0.0
Expand All @@ -432,7 +404,7 @@ Added in v1.0.0

```ts
export declare const layerWeb: (
connectionOptions: Platforms.HttpConnectionOptionsTagged | Platforms.HttpsConnectionOptionsTagged
connectionOptions: HttpConnectionOptionsTagged | HttpsConnectionOptionsTagged
) => DockerLayer
```

Expand Down
Loading
Loading