diff options
| -rw-r--r-- | .cirrus.yml | 11 | ||||
| -rw-r--r-- | Makefile | 7 | ||||
| -rw-r--r-- | pkg/api/handlers/exec.go | 25 | ||||
| -rw-r--r-- | pkg/api/handlers/generic/ping.go | 27 | ||||
| -rw-r--r-- | pkg/api/handlers/ping.go | 30 | ||||
| -rw-r--r-- | pkg/api/handlers/types.go | 4 | ||||
| -rw-r--r-- | pkg/api/server/register_exec.go | 329 | ||||
| -rw-r--r-- | pkg/api/server/register_images.go | 5 | ||||
| -rw-r--r-- | pkg/api/server/register_ping.go | 60 | ||||
| -rw-r--r-- | pkg/api/server/server.go | 1 | ||||
| -rw-r--r-- | pkg/api/server/swagger.go | 9 | ||||
| -rw-r--r-- | pkg/api/tags.yaml | 8 |
12 files changed, 476 insertions, 40 deletions
diff --git a/.cirrus.yml b/.cirrus.yml index bb2da0812..8f355b3ba 100644 --- a/.cirrus.yml +++ b/.cirrus.yml @@ -93,7 +93,6 @@ gating_task: CIRRUS_WORKING_DIR: "/usr/src/libpod" GOPATH: "/go" GOSRC: "/go/src/github.com/containers/libpod" - EPOCH_TEST_COMMIT: "${CIRRUS_BASE_SHA}" # Runs within Cirrus's "community cluster" container: @@ -103,6 +102,16 @@ gating_task: timeout_in: 20m + # Custom cloning is required to satisfy lint/validation needs + clone_script: | + git clone --recursive --branch=$DEST_BRANCH https://x-access-token:${CIRRUS_REPO_CLONE_TOKEN}@github.com/${CIRRUS_REPO_FULL_NAME}.git $CIRRUS_WORKING_DIR + git remote update origin + if [[ -n "$CIRRUS_PR" ]]; then # running for a PR + git fetch origin pull/$CIRRUS_PR/head:pull/$CIRRUS_PR + git checkout pull/$CIRRUS_PR + fi + git reset --hard $CIRRUS_CHANGE_IN_REPO + # Don't bother going further if something is down networking_script: '${CIRRUS_WORKING_DIR}/${SCRIPT_BASE}/networking.sh' @@ -3,7 +3,7 @@ export GOPROXY=https://proxy.golang.org GO ?= go DESTDIR ?= -EPOCH_TEST_COMMIT ?= $(shell git merge-base HEAD $${DEST_BRANCH:-master}) +EPOCH_TEST_COMMIT ?= $(shell git merge-base $${DEST_BRANCH:-master} HEAD) HEAD ?= HEAD CHANGELOG_BASE ?= HEAD~ CHANGELOG_TARGET ?= HEAD @@ -132,6 +132,9 @@ for cmd in sorted(cmds): endef export PRINT_HELP_PYSCRIPT +# Dereference variable $(1), return value if non-empty, otherwise raise an error. +err_if_empty = $(if $(strip $($(1))),$(strip $($(1))),$(error Required variable $(1) value is undefined, whitespace, or empty)) + .PHONY: help help: @$(PYTHON) -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST) @@ -146,6 +149,7 @@ endif .PHONY: lint lint: golangci-lint + @echo "Linting vs commit '$(call err_if_empty,EPOCH_TEST_COMMIT)'" ifeq ($(PRE_COMMIT),) @echo "FATAL: pre-commit was not found, check https://pre-commit.com/ about installing it." >&2 @exit 2 @@ -531,6 +535,7 @@ uninstall: .PHONY: .gitvalidation .gitvalidation: .gopathok + @echo "Validating vs commit '$(call err_if_empty,EPOCH_TEST_COMMIT)'" GIT_CHECK_EXCLUDE="./vendor:docs/make.bat" $(GOBIN)/git-validation -run DCO,short-subject,dangling-whitespace -range $(EPOCH_TEST_COMMIT)..$(HEAD) .PHONY: install.tools diff --git a/pkg/api/handlers/exec.go b/pkg/api/handlers/exec.go new file mode 100644 index 000000000..8a7b2ae26 --- /dev/null +++ b/pkg/api/handlers/exec.go @@ -0,0 +1,25 @@ +package handlers + +import ( + "net/http" + + "github.com/containers/libpod/libpod/define" + "github.com/containers/libpod/pkg/api/handlers/utils" +) + +func CreateExec(w http.ResponseWriter, r *http.Request) { + utils.Error(w, "function not implemented", http.StatusInternalServerError, define.ErrNotImplemented) +} + +func StartExec(w http.ResponseWriter, r *http.Request) { + utils.Error(w, "function not implemented", http.StatusInternalServerError, define.ErrNotImplemented) +} + +func ResizeExec(w http.ResponseWriter, r *http.Request) { + utils.Error(w, "function not implemented", http.StatusInternalServerError, define.ErrNotImplemented) + +} + +func InspectExec(w http.ResponseWriter, r *http.Request) { + utils.Error(w, "function not implemented", http.StatusInternalServerError, define.ErrNotImplemented) +} diff --git a/pkg/api/handlers/generic/ping.go b/pkg/api/handlers/generic/ping.go deleted file mode 100644 index 00afd86bc..000000000 --- a/pkg/api/handlers/generic/ping.go +++ /dev/null @@ -1,27 +0,0 @@ -package generic - -import ( - "fmt" - "net/http" - - "github.com/containers/libpod/pkg/api/handlers" -) - -func PingGET(w http.ResponseWriter, _ *http.Request) { - setHeaders(w) - fmt.Fprintln(w, "OK") -} - -func PingHEAD(w http.ResponseWriter, _ *http.Request) { - setHeaders(w) - fmt.Fprintln(w, "") -} - -func setHeaders(w http.ResponseWriter) { - w.Header().Set("API-Version", handlers.DefaultApiVersion) - w.Header().Set("BuildKit-Version", "") - w.Header().Set("Docker-Experimental", "true") - w.Header().Set("Cache-Control", "no-cache") - w.Header().Set("Pragma", "no-cache") - w.WriteHeader(http.StatusOK) -} diff --git a/pkg/api/handlers/ping.go b/pkg/api/handlers/ping.go new file mode 100644 index 000000000..d41da60f3 --- /dev/null +++ b/pkg/api/handlers/ping.go @@ -0,0 +1,30 @@ +package handlers + +import ( + "fmt" + "net/http" + + "github.com/containers/buildah" +) + +// Ping returns headers to client about the service +// +// This handler must always be the same for the compatibility and libpod URL trees! +// Clients will use the Header availability to test which backend engine is in use. +func Ping(w http.ResponseWriter, r *http.Request) { + w.Header().Set("API-Version", DefaultApiVersion) + w.Header().Set("BuildKit-Version", "") + w.Header().Set("Docker-Experimental", "true") + w.Header().Set("Cache-Control", "no-cache") + w.Header().Set("Pragma", "no-cache") + + // API-Version and Libpod-API-Version may not always be equal + w.Header().Set("Libpod-API-Version", DefaultApiVersion) + w.Header().Set("Libpod-Buildha-Version", buildah.Version) + w.WriteHeader(http.StatusOK) + + if r.Method == http.MethodGet { + fmt.Fprint(w, "OK") + } + fmt.Fprint(w, "\n") +} diff --git a/pkg/api/handlers/types.go b/pkg/api/handlers/types.go index 9c8562744..34b428852 100644 --- a/pkg/api/handlers/types.go +++ b/pkg/api/handlers/types.go @@ -70,10 +70,6 @@ type ContainerStats struct { docker.ContainerStats } -type Ping struct { - docker.Ping -} - type Version struct { docker.Version } diff --git a/pkg/api/server/register_exec.go b/pkg/api/server/register_exec.go new file mode 100644 index 000000000..dbf04dc19 --- /dev/null +++ b/pkg/api/server/register_exec.go @@ -0,0 +1,329 @@ +package server + +import ( + "net/http" + + "github.com/containers/libpod/pkg/api/handlers" + "github.com/gorilla/mux" +) + +func (s *APIServer) registerExecHandlers(r *mux.Router) error { + // swagger:operation POST /containers/{name}/create compat createExec + // --- + // tags: + // - exec (compat) + // summary: Create an exec instance + // description: Run a command inside a running container. + // parameters: + // - in: path + // name: name + // type: string + // required: true + // description: name of container + // - in: body + // name: control + // description: Attributes for create + // schema: + // type: object + // properties: + // AttachStdin: + // type: boolean + // description: Attach to stdin of the exec command + // AttachStdout: + // type: boolean + // description: Attach to stdout of the exec command + // AttachStderr: + // type: boolean + // description: Attach to stderr of the exec command + // DetachKeys: + // type: string + // description: | + // "Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _." + // Tty: + // type: boolean + // description: Allocate a pseudo-TTY + // Env: + // type: array + // description: A list of environment variables in the form ["VAR=value", ...] + // items: + // type: string + // Cmd: + // type: array + // description: Command to run, as a string or array of strings. + // items: + // type: string + // Privileged: + // type: boolean + // default: false + // description: Runs the exec process with extended privileges + // User: + // type: string + // description: | + // "The user, and optionally, group to run the exec process inside the container. Format is one of: user, user:group, uid, or uid:gid." + // WorkingDir: + // type: string + // description: The working directory for the exec process inside the container. + // produces: + // - application/json + // responses: + // 201: + // description: no error + // 404: + // $ref: "#/responses/NoSuchContainer" + // 409: + // description: container is paused + // 500: + // $ref: "#/responses/InternalError" + r.Handle(VersionedPath("/containers/{name}/create"), APIHandler(s.Context, handlers.CreateExec)).Methods(http.MethodPost) + // swagger:operation POST /exec/{id}/start compat startExec + // --- + // tags: + // - exec (compat) + // summary: Start an exec instance + // description: Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command. + // parameters: + // - in: path + // name: id + // type: string + // required: true + // description: Exec instance ID + // - in: body + // name: control + // description: Attributes for start + // schema: + // type: object + // properties: + // Detach: + // type: boolean + // description: Detach from the command + // Tty: + // type: boolean + // description: Allocate a pseudo-TTY + // produces: + // - application/json + // responses: + // 200: + // description: no error + // 404: + // $ref: "#/responses/NoSuchExecInstance" + // 409: + // description: container is stopped or paused + // 500: + // $ref: "#/responses/InternalError" + r.Handle(VersionedPath("/exec/{id}/start"), APIHandler(s.Context, handlers.StartExec)).Methods(http.MethodPost) + // swagger:operation POST /exec/{id}/resize compat resizeExec + // --- + // tags: + // - exec (compat) + // summary: Resize an exec instance + // description: | + // Resize the TTY session used by an exec instance. This endpoint only works if tty was specified as part of creating and starting the exec instance. + // parameters: + // - in: path + // name: id + // type: string + // required: true + // description: Exec instance ID + // - in: query + // name: h + // type: integer + // description: Height of the TTY session in characters + // - in: query + // name: w + // type: integer + // description: Width of the TTY session in characters + // produces: + // - application/json + // responses: + // 201: + // description: no error + // 404: + // $ref: "#/responses/NoSuchExecInstance" + // 500: + // $ref: "#/responses/InternalError" + r.Handle(VersionedPath("/exec/{id}/resize"), APIHandler(s.Context, handlers.ResizeExec)).Methods(http.MethodPost) + // swagger:operation GET /exec/{id}/inspect compat inspectExec + // --- + // tags: + // - exec (compat) + // summary: Inspect an exec instance + // description: Return low-level information about an exec instance. + // parameters: + // - in: path + // name: id + // type: string + // required: true + // description: Exec instance ID + // produces: + // - application/json + // responses: + // 200: + // description: no error + // 404: + // $ref: "#/responses/NoSuchExecInstance" + // 500: + // $ref: "#/responses/InternalError" + r.Handle(VersionedPath("/exec/{id}/json"), APIHandler(s.Context, handlers.InspectExec)).Methods(http.MethodGet) + + /* + libpod api follows + */ + + // swagger:operation POST /libpod/containers/{name}/create libpod libpodCreateExec + // --- + // tags: + // - exec + // summary: Create an exec instance + // description: Run a command inside a running container. + // parameters: + // - in: path + // name: name + // type: string + // required: true + // description: name of container + // - in: body + // name: control + // description: Attributes for create + // schema: + // type: object + // properties: + // AttachStdin: + // type: boolean + // description: Attach to stdin of the exec command + // AttachStdout: + // type: boolean + // description: Attach to stdout of the exec command + // AttachStderr: + // type: boolean + // description: Attach to stderr of the exec command + // DetachKeys: + // type: string + // description: | + // "Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _." + // Tty: + // type: boolean + // description: Allocate a pseudo-TTY + // Env: + // type: array + // description: A list of environment variables in the form ["VAR=value", ...] + // items: + // type: string + // Cmd: + // type: array + // description: Command to run, as a string or array of strings. + // items: + // type: string + // Privileged: + // type: boolean + // default: false + // description: Runs the exec process with extended privileges + // User: + // type: string + // description: | + // "The user, and optionally, group to run the exec process inside the container. Format is one of: user, user:group, uid, or uid:gid." + // WorkingDir: + // type: string + // description: The working directory for the exec process inside the container. + // produces: + // - application/json + // responses: + // 201: + // description: no error + // 404: + // $ref: "#/responses/NoSuchContainer" + // 409: + // description: container is paused + // 500: + // $ref: "#/responses/InternalError" + r.Handle(VersionedPath("/libpod/containers/{name}/create"), APIHandler(s.Context, handlers.CreateExec)).Methods(http.MethodPost) + // swagger:operation POST /libpod/exec/{id}/start libpod libpodStartExec + // --- + // tags: + // - exec + // summary: Start an exec instance + // description: Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command. + // parameters: + // - in: path + // name: id + // type: string + // required: true + // description: Exec instance ID + // - in: body + // name: control + // description: Attributes for start + // schema: + // type: object + // properties: + // Detach: + // type: boolean + // description: Detach from the command + // Tty: + // type: boolean + // description: Allocate a pseudo-TTY + // produces: + // - application/json + // responses: + // 200: + // description: no error + // 404: + // $ref: "#/responses/NoSuchExecInstance" + // 409: + // description: container is stopped or paused + // 500: + // $ref: "#/responses/InternalError" + r.Handle(VersionedPath("/libpod/exec/{id}/start"), APIHandler(s.Context, handlers.StartExec)).Methods(http.MethodPost) + // swagger:operation POST /libpod/exec/{id}/resize libpod libpodResizeExec + // --- + // tags: + // - exec + // summary: Resize an exec instance + // description: | + // Resize the TTY session used by an exec instance. This endpoint only works if tty was specified as part of creating and starting the exec instance. + // parameters: + // - in: path + // name: id + // type: string + // required: true + // description: Exec instance ID + // - in: query + // name: h + // type: integer + // description: Height of the TTY session in characters + // - in: query + // name: w + // type: integer + // description: Width of the TTY session in characters + // produces: + // - application/json + // responses: + // 201: + // description: no error + // 404: + // $ref: "#/responses/NoSuchExecInstance" + // 500: + // $ref: "#/responses/InternalError" + r.Handle(VersionedPath("/libpod/exec/{id}/resize"), APIHandler(s.Context, handlers.ResizeExec)).Methods(http.MethodPost) + // swagger:operation GET /libpod/exec/{id}/inspect libpod libpodInspectExec + // --- + // tags: + // - exec + // summary: Inspect an exec instance + // description: Return low-level information about an exec instance. + // parameters: + // - in: path + // name: id + // type: string + // required: true + // description: Exec instance ID + // produces: + // - application/json + // responses: + // 200: + // description: no error + // 404: + // $ref: "#/responses/NoSuchExecInstance" + // 500: + // $ref: "#/responses/InternalError" + r.Handle(VersionedPath("/libpod/exec/{id}/json"), APIHandler(s.Context, handlers.InspectExec)).Methods(http.MethodGet) + return nil +} diff --git a/pkg/api/server/register_images.go b/pkg/api/server/register_images.go index f1cc0574c..18a90dc3d 100644 --- a/pkg/api/server/register_images.go +++ b/pkg/api/server/register_images.go @@ -300,8 +300,9 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error { // swagger:operation POST /commit/ compat commitContainer // --- // tags: - // - commit (compat) - // summary: Create a new image from a container + // - containers (compat) + // summary: New Image + // description: Create a new image from a container // parameters: // - in: query // name: container diff --git a/pkg/api/server/register_ping.go b/pkg/api/server/register_ping.go index 4956f9822..086e674a1 100644 --- a/pkg/api/server/register_ping.go +++ b/pkg/api/server/register_ping.go @@ -3,15 +3,65 @@ package server import ( "net/http" - "github.com/containers/libpod/pkg/api/handlers/generic" + "github.com/containers/libpod/pkg/api/handlers" "github.com/gorilla/mux" ) func (s *APIServer) registerPingHandlers(r *mux.Router) error { - r.Handle("/_ping", APIHandler(s.Context, generic.PingGET)).Methods(http.MethodGet) - r.Handle("/_ping", APIHandler(s.Context, generic.PingHEAD)).Methods("HEAD") - // libpod - r.Handle("/libpod/_ping", APIHandler(s.Context, generic.PingGET)).Methods(http.MethodGet) + r.Handle("/_ping", APIHandler(s.Context, handlers.Ping)).Methods(http.MethodGet) + r.Handle("/_ping", APIHandler(s.Context, handlers.Ping)).Methods(http.MethodHead) + + // swagger:operation GET /libpod/_ping libpod libpodPingGet + // --- + // summary: Ping service + // description: | + // Return protocol information in response headers. + // `HEAD /libpod/_ping` is also supported. + // `/_ping` is available for compatibility with other engines. + // tags: + // - system (compat) + // - system + // produces: + // - text/plain + // responses: + // 200: + // description: Success + // schema: + // description: OK + // type: string + // example: "OK" + // headers: + // API-Version: + // type: string + // description: Max compatibility API Version the server supports + // BuildKit-Version: + // type: string + // description: Default version of docker image builder + // Docker-Experimental: + // type: boolean + // description: If the server is running with experimental mode enabled, always true + // Cache-Control: + // type: string + // description: always no-cache + // Pragma: + // type: string + // description: always no-cache + // Libpod-API-Version: + // type: string + // description: | + // Max Podman API Version the server supports. + // Available if service is backed by Podman, therefore may be used to + // determine if talking to Podman engine or another engine + // Libpod-Buildha-Version: + // type: string + // description: | + // Default version of libpod image builder. + // Available if service is backed by Podman, therefore may be used to + // determine if talking to Podman engine or another engine + // 500: + // $ref: "#/responses/InternalError" + r.Handle("/libpod/_ping", APIHandler(s.Context, handlers.Ping)).Methods(http.MethodGet) + r.Handle("/libpod/_ping", APIHandler(s.Context, handlers.Ping)).Methods(http.MethodHead) return nil } diff --git a/pkg/api/server/server.go b/pkg/api/server/server.go index d030961cb..7bb0f5481 100644 --- a/pkg/api/server/server.go +++ b/pkg/api/server/server.go @@ -105,6 +105,7 @@ func newServer(runtime *libpod.Runtime, duration time.Duration, listener *net.Li server.RegisterAuthHandlers, server.RegisterContainersHandlers, server.RegisterDistributionHandlers, + server.registerExecHandlers, server.registerHealthCheckHandlers, server.registerImagesHandlers, server.registerInfoHandlers, diff --git a/pkg/api/server/swagger.go b/pkg/api/server/swagger.go index 5098390bc..fc409d816 100644 --- a/pkg/api/server/swagger.go +++ b/pkg/api/server/swagger.go @@ -23,6 +23,15 @@ type swagErrNoSuchContainer struct { } } +// No such exec instance +// swagger:response NoSuchExecInstance +type swagErrNoSuchExecInstance struct { + // in:body + Body struct { + utils.ErrorModel + } +} + // No such volume // swagger:response NoSuchVolume type swagErrNoSuchVolume struct { diff --git a/pkg/api/tags.yaml b/pkg/api/tags.yaml index ad0de656f..3bf2bb64f 100644 --- a/pkg/api/tags.yaml +++ b/pkg/api/tags.yaml @@ -1,13 +1,21 @@ tags: - name: containers description: Actions related to containers + - name: exec + description: Actions related to exec - name: images description: Actions related to images - name: pods description: Actions related to pods - name: volumes description: Actions related to volumes + - name: system + description: Actions related to Podman engine - name: containers (compat) description: Actions related to containers for the compatibility endpoints + - name: exec (compat) + description: Actions related to exec for the compatibility endpoints - name: images (compat) description: Actions related to images for the compatibility endpoints + - name: system (compat) + description: Actions related to Podman and compatiblity engines |