# README
** Docker service**
| Service Id | Action | Description | Request | Response |
|---|---|---|---|---|
| docker | run | run requested docker service | RunRequest | ContainerInfo |
| docker | images | check docker image | ImagesRequest | ImagesResponse |
| docker | stop-images | stop docker containers matching specified images | StopImagesRequest | StopImagesResponse |
| docker | pull | pull requested docker image | PullRequest | ImageInfo |
| docker | process | check docker container processes | ContainerCheckRequest | ContainerCheckResponse |
| docker | start | start specified docker container | ContainerStartRequest | ContainerInfo |
| docker | exec | run command within specified docker container | ContainerRunCommandRequest | ContainerRunCommandResponse |
| docker | stop | stop specified docker container | ContainerStopRequest | ContainerInfo |
| docker | remove | remove specified docker container | ContainerRemoveRequest | ContainerRemoveResponse |
| docker | logs | fetch container logs (app stdout/stderr) | ContainerLogsRequest | ContainerLogsResponse |
| docker | inspect | inspect supplied instance name | InspectRequest | InspectResponse |
| docker | build | build docker image | BuildRequest | BuildResponse |
| docker | tag | create a target image that referes to source docker image | BuildRequest | BuildResponse |
| docker | login | store supplied credentials for provided repository in local docker store | LoginRequest | LoginResponse |
| docker | logout | remove credentials for supplied repository | LogoutRequest | LogoutResponse |
| docker | push | copy image to supplied repository | PushRequest | PushResponse |
| docker | composeUp | docker compose up | ComposeUpRequest | ComposeResponse |
| docker | comoseDown | docker compose down | ComposeDownRequest | ComposeResponse |
# Functions
IsGoogleCloudRegistry returns true if url is google docker cloud registry.
New creates a new docker service.
NewBaseRequest creates a new base request.
Create new docker compose error.
NewExecRequest creates a new request to run command inside container.
NewExecRequestFromURL creates a new container run request.
NewImagesRequest creates a new image request.
NewImagesRequestFromURL creates a new request from URL.
No description provided by the author
NewRunRequestFromURL creates a new request from URL.
# Constants
ServiceID represents docker service id.
# Structs
BaseRequest represents container base request.
BuildRequest represents docker build request.
BuildResponse represents docker build response.
Represents a native docker-compose file.
Error type related to any docker compose operations.
Request to compose, build and run multi-container docker services.
No description provided by the author
No description provided by the author
DockerBuildResponse represents docker build response.
ContainerInfo represents a docker container info.
ContainerStatusRequest represents a docker check container status request.
ContainerStatusResponse represents a docker container check response.
No description provided by the author
ExecRequest represents a docker run container command.
ExecResponse represents a docker run command response.
Maps to "expose:" section of the compose file
Ports will NOT be exposed from the container to the host machine.
ImageInfo represents docker image info.
ImagesRequest represents docker check image request.
ImagesResponse represents a docker check image response.
InspectRequest represents a docker inspect request, target name refers to container name.
InspectResponse represents a docker inspect request.
LoginRequest represents a docker pull request.
LoginResponse represents a docker pull request.
LogoutRequest represents a docker pull request.
LogoutResponse represents a docker pull request.
LogsRequest represents docker runner container logs to take stdout.
LogsResponse represents docker container logs response.
TBD.
Maps to "ports:" section of the compose file
Ports will be exposed from the container to the host machine
Format is host port:container port e.g.
PullRequest represents a docker pull request.
PullResponse represents a docker pull response.
PushRequest represents a docker push request.
PushResponse represents a docker push request.
RemoveRequest represents a docker remove container request.
RemoveResponse represents a docker remove container response.
RunRequest represents a docker run request.
RunResponse represents a docker run response.
StartRequest represents a docker container start request.
StartResponse represents a docker container start response.
StopImagesRequest represents docker stop running images request.
StopImagesResponse represents docker stop images response.
StopRequest represents a docker stop container request.
StopResponse represents a docker stop container response.
Tag represent a docker tag.
TagRequest represents docker tag request.
TagResponse represents docker tag response.
Maps to "volumes:" section of the compose file
Used to specify the path in host machine to be mounted and available within container and in which path.