2021-04-08 14:38:16 +00:00
###
### Makefile Navigation
###
#
# This file is organized based on approximate end-to-end workflow:
#
# 1. Variables and common definitions are located at the top
# to make finding them quicker.
# 2. Main entry-point targets, like "default", "all", and "help"
# 3. Targets for code formatting and validation
# 4. Primary build targets, like podman and podman-remote
# 5. Secondary build targets, shell completions, static and multi-arch.
# 6. Targets that format and build documentation
# 7. Testing targets
# 8. Release and package-building targets
# 9. Targets that install tools, utilities, binaries and packages
# 10. Uninstall / Cleanup targets
#
###
### Variables & Definitions
###
2019-08-30 08:32:29 +00:00
export GOPROXY = https://proxy.golang.org
2019-06-27 14:24:16 +00:00
2017-11-01 15:24:59 +00:00
GO ?= go
2020-07-21 12:54:57 +00:00
COVERAGE_PATH ?= .coverage
2019-06-07 05:46:41 +00:00
DESTDIR ?=
2021-06-30 15:39:19 +00:00
EPOCH_TEST_COMMIT ?= $( shell git merge-base $$ { DEST_BRANCH:-main} HEAD)
2017-11-03 19:37:22 +00:00
HEAD ?= HEAD
2018-03-17 14:52:54 +00:00
CHANGELOG_BASE ?= HEAD~
CHANGELOG_TARGET ?= HEAD
2020-07-28 12:23:45 +00:00
PROJECT := github.com/containers/podman
2021-06-30 15:39:19 +00:00
GIT_BASE_BRANCH ?= origin/main
Makefile: Use ?= for shell variables (ISODATE, etc.)
Previously, Make would execute these shell commands even if we didn't
need the resulting variable. With ?='s recursive expansion [1], we
only expand the variable when it's consumed. For example, the ISODATE
variable is only needed in the recipe for the changelog target, so
most Make invocations won't need the value, and the computation is
just making whatever Make actually is doing slower.
I've shifted the GIT_COMMIT and BUILD_INFO values over to
LDFLAGS_PODMAN, because the test/*/* targets don't care about those.
I've also moved the Go-specific -ldflags from the variables into the
recipes themselves, because callers probably expect C semantics for
LDFLAGS and not Go's wrapper. That means that there's no longer a
need for the LDFLAGS/BASE_LDFLAGS separation, so I'm just using
LDFLAGS (and LDFLAGS_PODMAN) now. That reduces the declared variables
to just LDFLAGS_PODMAN, so I've shifted that declaration up to get it
closer to its GIT_COMMIT and BUILD_INFO precursors.
[1]: https://www.gnu.org/software/make/manual/html_node/Setting.html
Signed-off-by: W. Trevor King <wking@tremily.us>
Closes: #777
Approved by: rhatdan
2018-05-15 23:27:07 +00:00
GIT_BRANCH ?= $( shell git rev-parse --abbrev-ref HEAD 2>/dev/null)
GIT_BRANCH_CLEAN ?= $( shell echo $( GIT_BRANCH) | sed -e "s/[^[:alnum:]]/-/g" )
2017-11-02 19:31:21 +00:00
LIBPOD_INSTANCE := libpod_dev
2019-06-07 05:46:41 +00:00
PREFIX ?= /usr/local
2017-11-01 15:24:59 +00:00
BINDIR ?= ${ PREFIX } /bin
LIBEXECDIR ?= ${ PREFIX } /libexec
MANDIR ?= ${ PREFIX } /share/man
2018-03-01 20:33:04 +00:00
SHAREDIR_CONTAINERS ?= ${ PREFIX } /share/containers
2021-06-25 20:38:47 +00:00
ETCDIR ?= ${ PREFIX } /etc
2018-05-18 20:28:51 +00:00
TMPFILESDIR ?= ${ PREFIX } /lib/tmpfiles.d
2018-03-26 14:39:14 +00:00
SYSTEMDDIR ?= ${ PREFIX } /lib/systemd/system
2019-07-25 10:39:26 +00:00
USERSYSTEMDDIR ?= ${ PREFIX } /lib/systemd/user
2020-06-03 13:33:52 +00:00
REMOTETAGS ?= remote exclude_graphdriver_btrfs btrfs_noversion exclude_graphdriver_devicemapper containers_image_openpgp
2019-05-08 06:49:08 +00:00
BUILDTAGS ?= \
$( shell hack/apparmor_tag.sh) \
$( shell hack/btrfs_installed_tag.sh) \
$( shell hack/btrfs_tag.sh) \
$( shell hack/selinux_tag.sh) \
$( shell hack/systemd_tag.sh) \
2021-08-27 12:12:56 +00:00
$( shell hack/libsubid_tag.sh) \
2019-05-08 06:49:08 +00:00
exclude_graphdriver_devicemapper \
2020-05-29 18:38:33 +00:00
seccomp
2020-01-07 20:46:18 +00:00
PYTHON ?= $( shell command -v python3 python| head -n1)
2019-11-29 10:00:13 +00:00
PKG_MANAGER ?= $( shell command -v dnf yum| head -n1)
2020-01-07 20:46:18 +00:00
# ~/.local/bin is not in PATH on all systems
PRE_COMMIT = $( shell command -v bin/venv/bin/pre-commit ~/.local/bin/pre-commit pre-commit | head -n1)
2019-11-29 10:00:13 +00:00
Makefile: make bin/* real targets!
Backstory: every time you run 'make podman' or even
just 'make', you get a full recompile. This is sub-ideal.
Cause: I don't really know. It looks complicated. #5017
introduced a .PHONY for bin/podman, for reasons not
explained in the PR. Then, much later, #5880 well-
intentionedly but improperly tweaked the 'find'
command used in defining SOURCES, adding a -prune
but without the corresponding and required -print.
Let's just say, it was an unfortunate cascade of events.
This PR fixes the SOURCES definition and removes the
highly-undesired .PHONY from podman & podman-remote,
making it so you can type 'make' and, oh joy, not
build anything if it's current. The way 'make' is
supposed to work.
Why fix this now? Because my PR (#9209) was failing in CI,
in the Validate step:
Can't exec "./bin/podman": No such file or directory at hack/xref-helpmsgs-manpages line 223.
It failed even on Re-run, and only passed once I force-pushed
the PR (with no changes, just a new commit SHA). I have no idea
why bin/podman wasn't built, and I have zero interest in pursuing
that right now, but the proper solution is to add bin/podman as
a Makefile dependency for that particular test. So done.
While I'm at it, fix what is pretty clearly a typo in a .PHONY
And, finally, fix a go-md2man warning introduced in #9189
[NO TESTS NEEDED]
Signed-off-by: Ed Santiago <santiago@redhat.com>
2021-02-02 23:10:54 +00:00
# This isn't what we actually build; it's a superset, used for target
# dependencies. Basically: all *.go files, except *_test.go, and except
# anything in a dot subdirectory. If any of these files is newer than
# our target (bin/podman{,-remote}), a rebuild is triggered.
SOURCES = $( shell find . -path './.*' -prune -o \( -name '*.go' -a ! -name '*_test.go' \) -print)
2019-05-08 06:49:08 +00:00
2020-09-17 16:22:12 +00:00
BUILDFLAGS := -mod= vendor $( BUILDFLAGS)
2019-08-01 11:28:40 +00:00
2020-06-03 13:33:52 +00:00
BUILDTAGS_CROSS ?= containers_image_openpgp exclude_graphdriver_btrfs exclude_graphdriver_devicemapper exclude_graphdriver_overlay
2018-11-02 23:28:31 +00:00
CONTAINER_RUNTIME := $( shell command -v podman 2> /dev/null || echo docker)
2019-02-05 13:52:03 +00:00
OCI_RUNTIME ?= ""
2018-06-22 13:56:08 +00:00
2021-04-08 14:38:16 +00:00
MANPAGES_MD ?= $( wildcard docs/source/markdown/*.md pkg/*/docs/*.md)
MANPAGES ?= $( MANPAGES_MD:%.md= %)
MANPAGES_DEST ?= $( subst markdown,man, $( subst source,build,$( MANPAGES) ) )
2017-11-01 15:24:59 +00:00
BASHINSTALLDIR = ${ PREFIX } /share/bash-completion/completions
2019-03-01 22:39:51 +00:00
ZSHINSTALLDIR = ${ PREFIX } /share/zsh/site-functions
2020-11-08 20:50:51 +00:00
FISHINSTALLDIR = ${ PREFIX } /share/fish/vendor_completions.d
2017-11-01 15:24:59 +00:00
SELINUXOPT ?= $( shell test -x /usr/sbin/selinuxenabled && selinuxenabled && echo -Z)
Makefile: Use ?= for shell variables (ISODATE, etc.)
Previously, Make would execute these shell commands even if we didn't
need the resulting variable. With ?='s recursive expansion [1], we
only expand the variable when it's consumed. For example, the ISODATE
variable is only needed in the recipe for the changelog target, so
most Make invocations won't need the value, and the computation is
just making whatever Make actually is doing slower.
I've shifted the GIT_COMMIT and BUILD_INFO values over to
LDFLAGS_PODMAN, because the test/*/* targets don't care about those.
I've also moved the Go-specific -ldflags from the variables into the
recipes themselves, because callers probably expect C semantics for
LDFLAGS and not Go's wrapper. That means that there's no longer a
need for the LDFLAGS/BASE_LDFLAGS separation, so I'm just using
LDFLAGS (and LDFLAGS_PODMAN) now. That reduces the declared variables
to just LDFLAGS_PODMAN, so I've shifted that declaration up to get it
closer to its GIT_COMMIT and BUILD_INFO precursors.
[1]: https://www.gnu.org/software/make/manual/html_node/Setting.html
Signed-off-by: W. Trevor King <wking@tremily.us>
Closes: #777
Approved by: rhatdan
2018-05-15 23:27:07 +00:00
COMMIT_NO ?= $( shell git rev-parse HEAD 2> /dev/null || true )
2019-02-04 17:37:11 +00:00
GIT_COMMIT ?= $( if $( shell git status --porcelain --untracked-files= no) ,${ COMMIT_NO } -dirty,${ COMMIT_NO } )
2019-06-20 21:14:18 +00:00
DATE_FMT = %s
i f d e f S O U R C E _ D A T E _ E P O C H
BUILD_INFO ?= $( shell date -u -d " @ $( SOURCE_DATE_EPOCH) " " + $( DATE_FMT) " 2>/dev/null || date -u -r " $( SOURCE_DATE_EPOCH) " " + $( DATE_FMT) " 2>/dev/null || date -u " + $( DATE_FMT) " )
ISODATE ?= $( shell date -d " @ $( SOURCE_DATE_EPOCH) " --iso-8601)
e l s e
BUILD_INFO ?= $( shell date " + $( DATE_FMT) " )
ISODATE ?= $( shell date --iso-8601)
e n d i f
2021-02-20 13:28:38 +00:00
LIBPOD := ${ PROJECT } /v3/libpod
2021-08-09 18:10:18 +00:00
GOFLAGS ?= -trimpath
2019-12-12 16:09:00 +00:00
LDFLAGS_PODMAN ?= \
2021-06-14 18:53:47 +00:00
-X $( LIBPOD) /define.gitCommit= $( GIT_COMMIT) \
-X $( LIBPOD) /define.buildInfo= $( BUILD_INFO) \
-X $( LIBPOD) /config._installPrefix= $( PREFIX) \
-X $( LIBPOD) /config._etcDir= $( ETCDIR) \
$( EXTRA_LDFLAGS)
LDFLAGS_PODMAN_STATIC ?= \
$( LDFLAGS_PODMAN) \
-extldflags= -static
2019-02-01 02:26:15 +00:00
#Update to LIBSECCOMP_COMMIT should reflect in Dockerfile too.
2020-01-09 19:20:51 +00:00
LIBSECCOMP_COMMIT := v2.3.3
2019-02-05 18:22:42 +00:00
# Rarely if ever should integration tests take more than 50min,
# caller may override in special circumstances if needed.
2019-03-04 18:18:10 +00:00
GINKGOTIMEOUT ?= -timeout= 90m
2019-02-05 18:22:42 +00:00
2021-09-16 20:15:28 +00:00
# Conditional required to produce empty-output if binary not built yet.
RELEASE_VERSION = $( shell if test -x test/version/version; then test/version/version; fi )
RELEASE_NUMBER = $( shell echo " $( RELEASE_VERSION) " | sed -e 's/^v\(.*\)/\1/' )
2019-07-01 18:52:55 +00:00
WIP: Enable (and disable) remote testing
podman-remote has not been tested. A principal part of the
problem was #5387 - the YAML I wrote did not have the
intended effect, it did not set TEST_REMOTE_CLIENT=true
and because of my multiple iterations I did not catch this
during testing.
Part 1 of this PR is to fix .cirrus.yml to enable remote tests.
Part 2 -- what I had first noticed and tried to fix -- is that
rootless_test.sh was never running remote because, of course,
envariables are not sent via ssh. I reworked integration_test.sh
and rootless_test.sh to use a command-line decision instead.
Part 3, sigh, is to disable one failing integration test
and *all* system tests, because so many of the latter are
failing. Addressing those failures needs to be done in
subsequent PRs. Issues #6538, #6539, #6540 are filed for
some of the problems I isolated. There will be more.
Also, minor, fixed some stale references to varlink.
Signed-off-by: Ed Santiago <santiago@redhat.com>
2020-06-08 20:57:37 +00:00
# If non-empty, logs all output from server during remote system testing
PODMAN_SERVER_LOG ?=
2019-10-08 18:20:44 +00:00
2017-11-01 15:24:59 +00:00
# If GOPATH not specified, use one in the local directory
i f e q ( $( GOPATH ) , )
2021-01-19 09:27:01 +00:00
export GOPATH := $( HOME) /go
2017-11-01 15:24:59 +00:00
u n export GOBIN
e n d i f
Makefile: Respect GOBIN
And use 'go env GOBIN' to detect the user's existing preference. From
[1]:
> The bin directory holds compiled commands. Each command is named
> for its source directory, but only the final element, not the entire
> path. That is, the command with source in DIR/src/foo/quux is
> installed into DIR/bin/quux, not DIR/bin/foo/quux. The "foo/"
> prefix is stripped so that you can add DIR/bin to your PATH to get
> at the installed commands. If the GOBIN environment variable is
> set, commands are installed to the directory it names instead of
> DIR/bin. GOBIN must be an absolute path.
> ...
> Go searches each directory listed in GOPATH to find source code, but
> new packages are always downloaded into the first directory in the
> list.
So if GOBIN is set, it will be non-empty, and we can use $(GOBIN)/...
If GOBIN is unset, 'go env GOBIN' will return an empty string (as it
does on Travis [2]). In that case, I'm assuming that the package in
question is in the first directory in GOPATH and using the new
FIRST_GOPATH (firstword and subst are documented in [3]). That's
probably fairly safe, since our previous GOPATH handling assumed it
only contained a single path, and nobody was complaining about that.
Using ?= allows us to skip the 'dirname' call if we end up not needing
GOPKGBASEDIR [4] (e.g. for the 'help' target). The recursive
expansion could cause an issue if the result of the shell expansions
included a '$', but those seem unlikely in GOPKGBASEDIR, GOMD2MAN, or
the manpage paths. I haven't used ?= for GOBIN, because we'll always
need the expanded value for the if check.
Using GOMD2MAN allows us to collapse old ||-based recipe into a less
confusing invocation. And using a static pattern rule [5] for
$(MANPAGES) lets us write a single rule to handle both section 1 and
section 5.
While I was updating the GOPATH handling, I moved .gopathok from the
possibly-shared $(GOPATH)/.gopathok to the
definitely-specific-to-this-project .gopathok. That may cause some
issues if you rebuild after changing your GOPATH without calling
'clean', but I don't expect folks to change their GOPATH frequently.
And the old approach would fail if different consumers were also using
the same flag path to mean something else (as CRI-O does [6]).
As part of cleaning up .gopathok, I've also collapsed clean's rm calls
into a single invocation. That will give us the same results with
less process setup/teardown penalties.
[1]: https://golang.org/cmd/go/#hdr-GOPATH_environment_variable
[2]: https://travis-ci.org/projectatomic/libpod/jobs/379345071#L459
[3]: https://www.gnu.org/software/make/manual/html_node/Text-Functions.html
[4]: https://www.gnu.org/software/make/manual/html_node/Setting.html
[5]: https://www.gnu.org/software/make/manual/html_node/Static-Usage.html
[6]: https://github.com/kubernetes-incubator/cri-o/blob/v1.10.1/Makefile#L62
Signed-off-by: W. Trevor King <wking@tremily.us>
Closes: #774
Approved by: mheon
2018-05-15 17:50:56 +00:00
FIRST_GOPATH := $( firstword $( subst :, ,$( GOPATH) ) )
GOPKGDIR := $( FIRST_GOPATH) /src/$( PROJECT)
GOPKGBASEDIR ?= $( shell dirname " $( GOPKGDIR) " )
2018-05-21 15:06:28 +00:00
GOBIN := $( shell $( GO) env GOBIN)
Makefile: Respect GOBIN
And use 'go env GOBIN' to detect the user's existing preference. From
[1]:
> The bin directory holds compiled commands. Each command is named
> for its source directory, but only the final element, not the entire
> path. That is, the command with source in DIR/src/foo/quux is
> installed into DIR/bin/quux, not DIR/bin/foo/quux. The "foo/"
> prefix is stripped so that you can add DIR/bin to your PATH to get
> at the installed commands. If the GOBIN environment variable is
> set, commands are installed to the directory it names instead of
> DIR/bin. GOBIN must be an absolute path.
> ...
> Go searches each directory listed in GOPATH to find source code, but
> new packages are always downloaded into the first directory in the
> list.
So if GOBIN is set, it will be non-empty, and we can use $(GOBIN)/...
If GOBIN is unset, 'go env GOBIN' will return an empty string (as it
does on Travis [2]). In that case, I'm assuming that the package in
question is in the first directory in GOPATH and using the new
FIRST_GOPATH (firstword and subst are documented in [3]). That's
probably fairly safe, since our previous GOPATH handling assumed it
only contained a single path, and nobody was complaining about that.
Using ?= allows us to skip the 'dirname' call if we end up not needing
GOPKGBASEDIR [4] (e.g. for the 'help' target). The recursive
expansion could cause an issue if the result of the shell expansions
included a '$', but those seem unlikely in GOPKGBASEDIR, GOMD2MAN, or
the manpage paths. I haven't used ?= for GOBIN, because we'll always
need the expanded value for the if check.
Using GOMD2MAN allows us to collapse old ||-based recipe into a less
confusing invocation. And using a static pattern rule [5] for
$(MANPAGES) lets us write a single rule to handle both section 1 and
section 5.
While I was updating the GOPATH handling, I moved .gopathok from the
possibly-shared $(GOPATH)/.gopathok to the
definitely-specific-to-this-project .gopathok. That may cause some
issues if you rebuild after changing your GOPATH without calling
'clean', but I don't expect folks to change their GOPATH frequently.
And the old approach would fail if different consumers were also using
the same flag path to mean something else (as CRI-O does [6]).
As part of cleaning up .gopathok, I've also collapsed clean's rm calls
into a single invocation. That will give us the same results with
less process setup/teardown penalties.
[1]: https://golang.org/cmd/go/#hdr-GOPATH_environment_variable
[2]: https://travis-ci.org/projectatomic/libpod/jobs/379345071#L459
[3]: https://www.gnu.org/software/make/manual/html_node/Text-Functions.html
[4]: https://www.gnu.org/software/make/manual/html_node/Setting.html
[5]: https://www.gnu.org/software/make/manual/html_node/Static-Usage.html
[6]: https://github.com/kubernetes-incubator/cri-o/blob/v1.10.1/Makefile#L62
Signed-off-by: W. Trevor King <wking@tremily.us>
Closes: #774
Approved by: mheon
2018-05-15 17:50:56 +00:00
i f e q ( $( GOBIN ) , )
GOBIN := $( FIRST_GOPATH) /bin
e n d i f
2021-01-19 09:27:01 +00:00
export PATH := $( PATH) :$( GOBIN)
Makefile: Respect GOBIN
And use 'go env GOBIN' to detect the user's existing preference. From
[1]:
> The bin directory holds compiled commands. Each command is named
> for its source directory, but only the final element, not the entire
> path. That is, the command with source in DIR/src/foo/quux is
> installed into DIR/bin/quux, not DIR/bin/foo/quux. The "foo/"
> prefix is stripped so that you can add DIR/bin to your PATH to get
> at the installed commands. If the GOBIN environment variable is
> set, commands are installed to the directory it names instead of
> DIR/bin. GOBIN must be an absolute path.
> ...
> Go searches each directory listed in GOPATH to find source code, but
> new packages are always downloaded into the first directory in the
> list.
So if GOBIN is set, it will be non-empty, and we can use $(GOBIN)/...
If GOBIN is unset, 'go env GOBIN' will return an empty string (as it
does on Travis [2]). In that case, I'm assuming that the package in
question is in the first directory in GOPATH and using the new
FIRST_GOPATH (firstword and subst are documented in [3]). That's
probably fairly safe, since our previous GOPATH handling assumed it
only contained a single path, and nobody was complaining about that.
Using ?= allows us to skip the 'dirname' call if we end up not needing
GOPKGBASEDIR [4] (e.g. for the 'help' target). The recursive
expansion could cause an issue if the result of the shell expansions
included a '$', but those seem unlikely in GOPKGBASEDIR, GOMD2MAN, or
the manpage paths. I haven't used ?= for GOBIN, because we'll always
need the expanded value for the if check.
Using GOMD2MAN allows us to collapse old ||-based recipe into a less
confusing invocation. And using a static pattern rule [5] for
$(MANPAGES) lets us write a single rule to handle both section 1 and
section 5.
While I was updating the GOPATH handling, I moved .gopathok from the
possibly-shared $(GOPATH)/.gopathok to the
definitely-specific-to-this-project .gopathok. That may cause some
issues if you rebuild after changing your GOPATH without calling
'clean', but I don't expect folks to change their GOPATH frequently.
And the old approach would fail if different consumers were also using
the same flag path to mean something else (as CRI-O does [6]).
As part of cleaning up .gopathok, I've also collapsed clean's rm calls
into a single invocation. That will give us the same results with
less process setup/teardown penalties.
[1]: https://golang.org/cmd/go/#hdr-GOPATH_environment_variable
[2]: https://travis-ci.org/projectatomic/libpod/jobs/379345071#L459
[3]: https://www.gnu.org/software/make/manual/html_node/Text-Functions.html
[4]: https://www.gnu.org/software/make/manual/html_node/Setting.html
[5]: https://www.gnu.org/software/make/manual/html_node/Static-Usage.html
[6]: https://github.com/kubernetes-incubator/cri-o/blob/v1.10.1/Makefile#L62
Signed-off-by: W. Trevor King <wking@tremily.us>
Closes: #774
Approved by: mheon
2018-05-15 17:50:56 +00:00
GOMD2MAN ?= $( shell command -v go-md2man || echo '$(GOBIN)/go-md2man' )
2017-11-01 15:24:59 +00:00
2018-06-29 21:47:53 +00:00
CROSS_BUILD_TARGETS := \
2020-03-10 18:45:31 +00:00
bin/podman.cross.linux.amd64 \
bin/podman.cross.linux.ppc64le \
2020-09-08 12:32:10 +00:00
bin/podman.cross.linux.arm \
bin/podman.cross.linux.arm64 \
bin/podman.cross.linux.386 \
2021-01-07 13:51:17 +00:00
bin/podman.cross.linux.s390x \
bin/podman.cross.linux.mips \
bin/podman.cross.linux.mipsle \
bin/podman.cross.linux.mips64 \
bin/podman.cross.linux.mips64le
2018-06-29 21:47:53 +00:00
2021-04-08 14:38:16 +00:00
# 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) )
2021-04-08 18:30:40 +00:00
# Podman does not work w/o CGO_ENABLED, except in some very specific cases
CGO_ENABLED ?= 1
2021-04-21 09:38:34 +00:00
# Default to the native OS type and architecture unless otherwise specified
2021-04-08 18:30:40 +00:00
GOOS ?= $( shell $( GO) env GOOS)
i f e q ( $( call err_if_empty ,GOOS ) , w i n d o w s )
BINSFX := .exe
SRCBINDIR := bin/windows
e l s e i f e q ( $( GOOS ) , d a r w i n )
BINSFX :=
SRCBINDIR := bin/darwin
e l s e
BINSFX := -remote
SRCBINDIR := bin
e n d i f
# Necessary for nested-$(MAKE) calls and docs/remote-docs.sh
export GOOS CGO_ENABLED BINSFX SRCBINDIR
2021-04-08 14:38:16 +00:00
d e f i n e g o - g e t
env GO111MODULE = off \
$( GO) get -u ${ 1 }
e n d e f
###
### Primary entry-point targets
###
Simplify Makefile help target
An in-line Python script, while flexible, is arguably
more complex and less stable than the long-lived `grep`,
`awk`, and `printf`. Make use of these simple tools
to display a column-aligned table of target and description
help output.
Also, the first target that appears in a Makefile is considered
the default (when no target is specified on the command-line).
However, despite it's name, the `default` target was not listed
first. Fix this, and redefine "default" target to "all" as
intended, instead of "help".
Lastly, add a small workaround for a vim syntax-hilighting bug.
Signed-off-by: Chris Evich <cevich@redhat.com>
2021-04-08 12:55:56 +00:00
.PHONY : default
default : all
2020-01-29 18:15:24 +00:00
.PHONY : all
2017-11-01 15:29:12 +00:00
all : binaries docs
2017-11-01 15:24:59 +00:00
2021-04-08 14:38:16 +00:00
.PHONY : binaries
2021-04-08 18:30:40 +00:00
binaries : podman podman -remote ## Build podman and podman-remote binaries
2020-02-03 16:58:38 +00:00
Simplify Makefile help target
An in-line Python script, while flexible, is arguably
more complex and less stable than the long-lived `grep`,
`awk`, and `printf`. Make use of these simple tools
to display a column-aligned table of target and description
help output.
Also, the first target that appears in a Makefile is considered
the default (when no target is specified on the command-line).
However, despite it's name, the `default` target was not listed
first. Fix this, and redefine "default" target to "all" as
intended, instead of "help".
Lastly, add a small workaround for a vim syntax-hilighting bug.
Signed-off-by: Chris Evich <cevich@redhat.com>
2021-04-08 12:55:56 +00:00
# Extract text following double-# for targets, as their description for
# the `help` target. Otherwise These simple-substitutions are resolved
# at reference-time (due to `=` and not `=:`).
_HLP_TGTS_RX = '^[[:print:]]+:.*?\#\# .*$$'
_HLP_TGTS_CMD = grep -E $( _HLP_TGTS_RX) $( MAKEFILE_LIST)
_HLP_TGTS_LEN = $( shell $( _HLP_TGTS_CMD) | cut -d : -f 1 | wc -L)
_HLPFMT = " %- $( _HLP_TGTS_LEN) s %s\n "
2020-01-29 18:15:24 +00:00
.PHONY : help
Simplify Makefile help target
An in-line Python script, while flexible, is arguably
more complex and less stable than the long-lived `grep`,
`awk`, and `printf`. Make use of these simple tools
to display a column-aligned table of target and description
help output.
Also, the first target that appears in a Makefile is considered
the default (when no target is specified on the command-line).
However, despite it's name, the `default` target was not listed
first. Fix this, and redefine "default" target to "all" as
intended, instead of "help".
Lastly, add a small workaround for a vim syntax-hilighting bug.
Signed-off-by: Chris Evich <cevich@redhat.com>
2021-04-08 12:55:56 +00:00
help : ## (Default) Print listing of key targets with their descriptions
@printf $( _HLPFMT) "Target:" "Description:"
@printf $( _HLPFMT) "--------------" "--------------------"
@$( _HLP_TGTS_CMD) | sort | \
awk ' BEGIN { FS = ":(.*)?## " } ; \
{ printf $( _HLPFMT) , $$ 1, $$ 2} '
2017-11-01 15:24:59 +00:00
2021-04-08 14:38:16 +00:00
###
### Linting/Formatting/Code Validation targets
###
2017-11-01 15:24:59 +00:00
.gopathok :
i f e q ( "$(wildcard $(GOPKGDIR))" , "" )
mkdir -p " $( GOPKGBASEDIR) "
2019-09-07 11:51:22 +00:00
ln -sfn " $( CURDIR) " " $( GOPKGDIR) "
2020-05-29 18:38:33 +00:00
e n d i f
Makefile: Respect GOBIN
And use 'go env GOBIN' to detect the user's existing preference. From
[1]:
> The bin directory holds compiled commands. Each command is named
> for its source directory, but only the final element, not the entire
> path. That is, the command with source in DIR/src/foo/quux is
> installed into DIR/bin/quux, not DIR/bin/foo/quux. The "foo/"
> prefix is stripped so that you can add DIR/bin to your PATH to get
> at the installed commands. If the GOBIN environment variable is
> set, commands are installed to the directory it names instead of
> DIR/bin. GOBIN must be an absolute path.
> ...
> Go searches each directory listed in GOPATH to find source code, but
> new packages are always downloaded into the first directory in the
> list.
So if GOBIN is set, it will be non-empty, and we can use $(GOBIN)/...
If GOBIN is unset, 'go env GOBIN' will return an empty string (as it
does on Travis [2]). In that case, I'm assuming that the package in
question is in the first directory in GOPATH and using the new
FIRST_GOPATH (firstword and subst are documented in [3]). That's
probably fairly safe, since our previous GOPATH handling assumed it
only contained a single path, and nobody was complaining about that.
Using ?= allows us to skip the 'dirname' call if we end up not needing
GOPKGBASEDIR [4] (e.g. for the 'help' target). The recursive
expansion could cause an issue if the result of the shell expansions
included a '$', but those seem unlikely in GOPKGBASEDIR, GOMD2MAN, or
the manpage paths. I haven't used ?= for GOBIN, because we'll always
need the expanded value for the if check.
Using GOMD2MAN allows us to collapse old ||-based recipe into a less
confusing invocation. And using a static pattern rule [5] for
$(MANPAGES) lets us write a single rule to handle both section 1 and
section 5.
While I was updating the GOPATH handling, I moved .gopathok from the
possibly-shared $(GOPATH)/.gopathok to the
definitely-specific-to-this-project .gopathok. That may cause some
issues if you rebuild after changing your GOPATH without calling
'clean', but I don't expect folks to change their GOPATH frequently.
And the old approach would fail if different consumers were also using
the same flag path to mean something else (as CRI-O does [6]).
As part of cleaning up .gopathok, I've also collapsed clean's rm calls
into a single invocation. That will give us the same results with
less process setup/teardown penalties.
[1]: https://golang.org/cmd/go/#hdr-GOPATH_environment_variable
[2]: https://travis-ci.org/projectatomic/libpod/jobs/379345071#L459
[3]: https://www.gnu.org/software/make/manual/html_node/Text-Functions.html
[4]: https://www.gnu.org/software/make/manual/html_node/Setting.html
[5]: https://www.gnu.org/software/make/manual/html_node/Static-Usage.html
[6]: https://github.com/kubernetes-incubator/cri-o/blob/v1.10.1/Makefile#L62
Signed-off-by: W. Trevor King <wking@tremily.us>
Closes: #774
Approved by: mheon
2018-05-15 17:50:56 +00:00
touch $@
2017-11-01 15:24:59 +00:00
2021-04-08 14:38:16 +00:00
.PHONY : .gitvalidation
.gitvalidation : .gopathok
@echo " Validating vs commit ' $( call err_if_empty,EPOCH_TEST_COMMIT) ' "
2021-02-09 21:33:19 +00:00
GIT_CHECK_EXCLUDE = "./vendor:docs/make.bat:test/buildah-bud/buildah-tests.diff" $( GOBIN) /git-validation -run DCO,short-subject,dangling-whitespace -range $( EPOCH_TEST_COMMIT) ..$( HEAD)
2021-04-08 14:38:16 +00:00
2020-01-29 18:15:24 +00:00
.PHONY : lint
2020-01-13 10:13:59 +00:00
lint : golangci -lint
2020-02-03 16:58:38 +00:00
@echo " Linting vs commit ' $( call err_if_empty,EPOCH_TEST_COMMIT) ' "
2020-01-07 20:46:18 +00:00
i f e q ( $( PRE_COMMIT ) , )
2020-02-18 14:28:47 +00:00
@echo "FATAL: pre-commit was not found, make .install.pre-commit to installing it." >& 2
2020-01-07 20:46:18 +00:00
@exit 2
e n d i f
$( PRE_COMMIT) run -a
2017-11-01 15:24:59 +00:00
2020-01-29 18:15:24 +00:00
.PHONY : golangci -lint
2020-11-18 21:12:33 +00:00
golangci-lint : .gopathok .install .golangci -lint
2020-04-02 22:58:23 +00:00
hack/golangci-lint.sh run
2019-07-22 18:08:06 +00:00
2020-01-29 18:15:24 +00:00
.PHONY : gofmt
2019-02-06 17:27:00 +00:00
gofmt : ## Verify the source code gofmt
2020-06-25 21:38:33 +00:00
find . -name '*.go' -type f \
-not \( \
-name '.golangci.yml' -o \
-name 'Makefile' -o \
-path './vendor/*' -prune -o \
-path './contrib/*' -prune \
\) -exec gofmt -d -e -s -w { } \+
2018-07-02 15:45:06 +00:00
git diff --exit-code
2017-12-12 18:40:20 +00:00
2020-01-29 18:15:24 +00:00
.PHONY : test /checkseccomp /checkseccomp
2017-11-01 15:24:59 +00:00
test/checkseccomp/checkseccomp : .gopathok $( wildcard test /checkseccomp /*.go )
2020-09-17 16:22:12 +00:00
$( GO) build $( BUILDFLAGS) -ldflags '$(LDFLAGS_PODMAN)' -tags " $( BUILDTAGS) " -o $@ ./test/checkseccomp
2017-11-01 15:24:59 +00:00
2021-01-11 21:14:07 +00:00
.PHONY : test /testvol /testvol
test/testvol/testvol : .gopathok $( wildcard test /testvol /*.go )
$( GO) build $( BUILDFLAGS) -ldflags '$(LDFLAGS_PODMAN)' -o $@ ./test/testvol
.PHONY : volume -plugin -test -image
volume-plugin-test-img :
podman build -t quay.io/libpod/volume-plugin-test-img -f Containerfile-testvol .
2020-12-21 22:48:43 +00:00
.PHONY : test /goecho /goecho
2018-10-29 06:56:07 +00:00
test/goecho/goecho : .gopathok $( wildcard test /goecho /*.go )
2020-09-17 16:22:12 +00:00
$( GO) build $( BUILDFLAGS) -ldflags '$(LDFLAGS_PODMAN)' -o $@ ./test/goecho
2018-10-29 06:56:07 +00:00
2021-09-16 20:15:28 +00:00
test/version/version : .gopathok version /version .go
$( GO) build -o $@ ./test/version/
2021-04-08 14:38:16 +00:00
.PHONY : codespell
codespell :
2021-09-07 13:52:24 +00:00
codespell -S bin,vendor,.git,go.sum,.cirrus.yml,"RELEASE_NOTES.md,*.xz,*.gz,*.ps1,*.tar,*.tgz,bin2img,*ico,*.png,*.1,*.5,copyimg,*.orig,apidoc.go" -L uint,iff,od,seeked,splitted,marge,ERRO,hist,ether -w
2021-04-08 14:38:16 +00:00
.PHONY : validate
2021-07-20 16:42:57 +00:00
validate : gofmt lint .gitvalidation validate .completions man -page -check swagger -check tests -included tests -expect -exit
2021-04-08 14:38:16 +00:00
.PHONY : build -all -new -commits
build-all-new-commits :
# Validate that all the commits build on top of $(GIT_BASE_BRANCH)
git rebase $( GIT_BASE_BRANCH) -x make
.PHONY : vendor
vendor :
GO111MODULE = on $( GO) mod tidy
GO111MODULE = on $( GO) mod vendor
GO111MODULE = on $( GO) mod verify
.PHONY : vendor -in -container
vendor-in-container :
podman run --privileged --rm --env HOME = /root \
-v $( CURDIR) :/src -w /src \
docker.io/library/golang:1.16 \
make vendor
###
### Primary binary-build targets
###
2020-01-29 16:09:01 +00:00
# Make sure to warn in case we're building without the systemd buildtag.
2021-04-08 14:38:16 +00:00
bin/podman : .gopathok $( SOURCES ) go .mod go .sum
2020-01-29 16:09:01 +00:00
i f e q ( , $( findstring systemd ,$ ( BUILDTAGS ) ) )
2021-04-08 14:38:16 +00:00
@echo " Podman is being compiled without the systemd build tag. \
Install libsystemd on Ubuntu or systemd-devel on rpm based \
distro for journald support."
2020-01-29 16:09:01 +00:00
e n d i f
2021-04-08 18:30:40 +00:00
CGO_ENABLED = $( CGO_ENABLED) \
$( GO) build \
2021-04-08 14:38:16 +00:00
$( BUILDFLAGS) \
-ldflags '$(LDFLAGS_PODMAN)' \
-tags " $( BUILDTAGS) " \
-o $@ ./cmd/podman
2017-11-01 15:24:59 +00:00
2021-04-08 18:30:40 +00:00
# Disambiguate Linux vs Darwin/Windows platform binaries under distinct "bin" dirs
$(SRCBINDIR) :
mkdir -p $( SRCBINDIR)
2019-12-29 20:04:56 +00:00
2021-04-08 18:30:40 +00:00
$(SRCBINDIR)/podman$(BINSFX) : $( SRCBINDIR ) .gopathok $( SOURCES ) go .mod go .sum
CGO_ENABLED = $( CGO_ENABLED) \
GOOS = $( GOOS) \
$( GO) build \
$( BUILDFLAGS) \
-ldflags '$(LDFLAGS_PODMAN)' \
-tags " ${ REMOTETAGS } " \
-o $@ ./cmd/podman
2021-04-08 14:38:16 +00:00
2021-04-08 18:30:40 +00:00
$(SRCBINDIR)/podman-remote-static : $( SRCBINDIR ) .gopathok $( SOURCES ) go .mod go .sum
2021-06-14 18:53:47 +00:00
CGO_ENABLED = 0 \
2021-04-08 18:30:40 +00:00
GOOS = $( GOOS) \
$( GO) build \
$( BUILDFLAGS) \
-ldflags '$(LDFLAGS_PODMAN_STATIC)' \
-tags " ${ REMOTETAGS } " \
-o $@ ./cmd/podman
2020-05-05 21:41:13 +00:00
2021-04-08 18:30:40 +00:00
.PHONY : podman
podman : bin /podman
2019-12-29 20:04:56 +00:00
2021-04-08 18:30:40 +00:00
.PHONY : podman -remote
podman-remote : $( SRCBINDIR ) $( SRCBINDIR ) /podman $( BINSFX ) ## Build podman-remote binary
# A wildcard podman-remote-% target incorrectly sets GOOS for release targets
.PHONY : podman -remote -linux
podman-remote-linux : ## Build podman-remote for Linux
$( MAKE) \
CGO_ENABLED = 0 \
GOOS = linux \
bin/podman-remote
PHONY : podman -remote -static
podman-remote-static : $( SRCBINDIR ) /podman -remote -static
.PHONY : podman -remote -windows
podman-remote-windows : ## Build podman-remote for Windows
$( MAKE) \
CGO_ENABLED = 0 \
GOOS = windows \
bin/windows/podman.exe
.PHONY : podman -remote -darwin
2021-05-06 14:36:59 +00:00
podman-remote-darwin : ## Build podman-remote for macOS
2021-04-08 18:30:40 +00:00
$( MAKE) \
CGO_ENABLED = 0 \
GOOS = darwin \
bin/darwin/podman
2019-04-22 21:01:31 +00:00
2021-04-08 14:38:16 +00:00
###
### Secondary binary-build targets
###
.PHONY : generate -bindings
generate-bindings :
2021-04-08 18:30:40 +00:00
i f n e q ( $( GOOS ) , d a r w i n )
2021-04-08 14:38:16 +00:00
GO111MODULE = off $( GO) generate ./pkg/bindings/... ;
e n d i f
2018-06-29 21:47:53 +00:00
2021-04-08 18:30:40 +00:00
# DO NOT USE: use local-cross instead
2018-06-29 21:47:53 +00:00
bin/podman.cross.% : .gopathok
TARGET = " $* " ; \
2021-04-08 18:30:40 +00:00
GOOS = " $$ {TARGET%%.*} " ; \
GOARCH = " $$ {TARGET##*.} " ; \
CGO_ENABLED = 0 \
$( GO) build \
$( BUILDFLAGS) \
-ldflags '$(LDFLAGS_PODMAN)' \
-tags '$(BUILDTAGS_CROSS)' \
-o " $@ " ./cmd/podman
2018-06-20 18:23:24 +00:00
2021-04-08 14:38:16 +00:00
.PHONY : local -cross
local-cross : $( CROSS_BUILD_TARGETS ) ## Cross compile podman binary for multiple architectures
2021-05-20 20:09:40 +00:00
.PHONY : cross
cross : local -cross
2020-05-27 06:30:40 +00:00
# Update nix/nixpkgs.json its latest stable commit
2020-03-20 09:55:23 +00:00
.PHONY : nixpkgs
nixpkgs :
2021-04-02 03:51:30 +00:00
@nix run \
2021-06-03 03:16:17 +00:00
-f channel:nixos-21.05 nix-prefetch-git \
2021-04-02 03:51:30 +00:00
-c nix-prefetch-git \
--no-deepClone \
2021-06-03 03:16:17 +00:00
https://github.com/nixos/nixpkgs refs/heads/nixos-21.05 > nix/nixpkgs.json
2020-03-20 09:55:23 +00:00
2020-05-27 06:30:40 +00:00
# Build statically linked binary
.PHONY : static
static :
@nix build -f nix/
mkdir -p ./bin
cp -rfp ./result/bin/* ./bin/
2020-03-20 09:55:23 +00:00
2021-04-08 14:38:16 +00:00
.PHONY : build -no -cgo
build-no-cgo :
BUILDTAGS = " containers_image_openpgp exclude_graphdriver_btrfs \
exclude_graphdriver_devicemapper exclude_disk_quota" \
CGO_ENABLED = 0 \
$( MAKE) all
.PHONY : completions
completions : podman podman -remote
# key = shell, value = completion filename
declare -A outfiles = ( [ bash] = %s [ zsh] = _%s [ fish] = %s.fish [ powershell] = %s.ps1) ; \
for shell in $$ { !outfiles[ *] } ; do \
for remote in "" "-remote" ; do \
podman = " podman $$ remote " ; \
outfile = $$ ( printf " completions/ $$ shell/ $$ {outfiles[ $$ shell]} " $$ podman) ; \
./bin/$$ podman completion $$ shell >| $$ outfile; \
done ; \
done
###
### Documentation targets
###
Initial commit on compatible API
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Create service command
Use cd cmd/service && go build .
$ systemd-socket-activate -l 8081 cmd/service/service &
$ curl http://localhost:8081/v1.24/images/json
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Correct Makefile
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Two more stragglers
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Report errors back as http headers
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Split out handlers, updated output
Output aligned to docker structures
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Refactored routing, added more endpoints and types
* Encapsulated all the routing information in the handler_* files.
* Added more serviceapi/types, including podman additions. See Info
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Cleaned up code, implemented info content
* Move Content-Type check into serviceHandler
* Custom 404 handler showing the url, mostly for debugging
* Refactored images: better method names and explicit http codes
* Added content to /info
* Added podman fields to Info struct
* Added Container struct
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Add a bunch of endpoints
containers: stop, pause, unpause, wait, rm
images: tag, rmi, create (pull only)
Signed-off-by: baude <bbaude@redhat.com>
Add even more handlers
* Add serviceapi/Error() to improve error handling
* Better support for API return payloads
* Renamed unimplemented to unsupported these are generic endpoints
we don't intend to ever support. Swarm broken out since it uses
different HTTP codes to signal that the node is not in a swarm.
* Added more types
* API Version broken out so it can be validated in the future
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Refactor to introduce ServiceWriter
Signed-off-by: Jhon Honce <jhonce@redhat.com>
populate pods endpoints
/libpod/pods/..
exists, kill, pause, prune, restart, remove, start, stop, unpause
Signed-off-by: baude <bbaude@redhat.com>
Add components to Version, fix Error body
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Add images pull output, fix swarm routes
* docker-py tests/integration/api_client_test.py pass 100%
* docker-py tests/integration/api_image_test.py pass 4/16
+ Test failures include services podman does not support
Signed-off-by: Jhon Honce <jhonce@redhat.com>
pods endpoint submission 2
add create and others; only top and stats is left.
Signed-off-by: baude <bbaude@redhat.com>
Update pull image to work from empty registry
Signed-off-by: Jhon Honce <jhonce@redhat.com>
pod create and container create
first pass at pod and container create. the container create does not
quite work yet but it is very close. pod create needs a partial
rewrite. also broken off the DELETE (rm/rmi) to specific handler funcs.
Signed-off-by: baude <bbaude@redhat.com>
Add docker-py demos, GET .../containers/json
* Update serviceapi/types to reflect libpod not podman
* Refactored removeImage() to provide non-streaming return
Signed-off-by: Jhon Honce <jhonce@redhat.com>
create container part2
finished minimal config needed for create container. started demo.py
for upcoming talk
Signed-off-by: baude <bbaude@redhat.com>
Stop server after honoring request
* Remove casting for method calls
* Improve WriteResponse()
* Update Container API type to match docker API
Signed-off-by: Jhon Honce <jhonce@redhat.com>
fix namespace assumptions
cleaned up namespace issues with libpod.
Signed-off-by: baude <bbaude@redhat.com>
wip
Signed-off-by: baude <bbaude@redhat.com>
Add sliding window when shutting down server
* Added a Timeout rather than closing down service on each call
* Added gorilla/schema dependency for Decode'ing query parameters
* Improved error handling
* Container logs returned and multiplexed for stdout and stderr
* .../containers/{name}/logs?stdout=True&stderr=True
* Container stats
* .../containers/{name}/stats
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Improve error handling
* Add check for at least one std stream required for /containers/{id}/logs
* Add check for state in /containers/{id}/top
* Fill in more fields for /info
* Fixed error checking in service start code
Signed-off-by: Jhon Honce <jhonce@redhat.com>
get rest of image tests for pass
Signed-off-by: baude <bbaude@redhat.com>
linting our content
Signed-off-by: baude <bbaude@redhat.com>
more linting
Signed-off-by: baude <bbaude@redhat.com>
more linting
Signed-off-by: baude <bbaude@redhat.com>
pruning
Signed-off-by: baude <bbaude@redhat.com>
[CI:DOCS]apiv2 pods
migrate from using args in the url to using a json struct in body for
pod create.
Signed-off-by: baude <bbaude@redhat.com>
fix handler_images prune
prune's api changed slightly to deal with filters.
Signed-off-by: baude <bbaude@redhat.com>
[CI:DOCS]enabled base container create tests
enabling the base container create tests which allow us to get more into
the stop, kill, etc tests. many new tests now pass.
Signed-off-by: baude <bbaude@redhat.com>
serviceapi errors: append error message to API message
I dearly hope this is not breaking any other tests but debugging
"Internal Server Error" is not helpful to any user. In case, it
breaks tests, we can rever the commit - that's why it's a small one.
Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
serviceAPI: add containers/prune endpoint
Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
add `service` make target
Also remove the non-functional sub-Makefile.
Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
add make targets for testing the service
* `sudo make run-service` for running the service.
* `DOCKERPY_TEST="tests/integration/api_container_test.py::ListContainersTest" \
make run-docker-py-tests`
for running a specific tests. Run all tests by leaving the env
variable empty.
Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
Split handlers and server packages
The files were split to help contain bloat. The api/server package will
contain all code related to the functioning of the server while
api/handlers will have all the code related to implementing the end
points.
api/server/register_* will contain the methods for registering
endpoints. Additionally, they will have the comments for generating the
swagger spec file.
See api/handlers/version.go for a small example handler,
api/handlers/containers.go contains much more complex handlers.
Signed-off-by: Jhon Honce <jhonce@redhat.com>
[CI:DOCS]enabled more tests
Signed-off-by: baude <bbaude@redhat.com>
[CI:DOCS]libpod endpoints
small refactor for libpod inclusion and began adding endpoints.
Signed-off-by: baude <bbaude@redhat.com>
Implement /build and /events
* Include crypto libraries for future ssh work
Signed-off-by: Jhon Honce <jhonce@redhat.com>
[CI:DOCS]more image implementations
convert from using for to query structs among other changes including
new endpoints.
Signed-off-by: baude <bbaude@redhat.com>
[CI:DOCS]add bindings for golang
Signed-off-by: baude <bbaude@redhat.com>
[CI:DOCS]add volume endpoints for libpod
create, inspect, ls, prune, and rm
Signed-off-by: baude <bbaude@redhat.com>
[CI:DOCS]apiv2 healthcheck enablement
wire up container healthchecks for the api.
Signed-off-by: baude <bbaude@redhat.com>
[CI:DOCS]Add mount endpoints
via the api, allow ability to mount a container and list container
mounts.
Signed-off-by: baude <bbaude@redhat.com>
[CI:DOCS]Add search endpoint
add search endpoint with golang bindings
Signed-off-by: baude <bbaude@redhat.com>
[CI:DOCS]more apiv2 development
misc population of methods, etc
Signed-off-by: baude <bbaude@redhat.com>
rebase cleanup and epoch reset
Signed-off-by: baude <bbaude@redhat.com>
[CI:DOCS]add more network endpoints
also, add some initial error handling and convenience functions for
standard endpoints.
Signed-off-by: baude <bbaude@redhat.com>
[CI:DOCS]use helper funcs for bindings
use the methods developed to make writing bindings less duplicative and
easier to use.
Signed-off-by: baude <bbaude@redhat.com>
[CI:DOCS]add return info for prereview
begin to add return info and status codes for errors so that we can
review the apiv2
Signed-off-by: baude <bbaude@redhat.com>
[CI:DOCS]first pass at adding swagger docs for api
Signed-off-by: baude <bbaude@redhat.com>
2019-11-01 20:03:34 +00:00
2021-02-18 21:08:01 +00:00
pkg/api/swagger.yaml : .gopathok
2020-01-17 15:41:40 +00:00
make -C pkg/api
2021-04-08 14:38:16 +00:00
$(MANPAGES) : %: %.md .install .md 2man docdir
2021-06-01 20:56:27 +00:00
### sed is used to filter http/s links as well as relative links
### replaces "\" at the end of a line with two spaces
### this ensures that manpages are renderd correctly
@sed -e 's/\((podman[^)]*\.md\(#.*\)\?)\)//g' \
-e 's/\[\(podman[^]]*\)\]/\1/g' \
-e 's/\[\([^]]*\)](http[^)]\+)/\1/g' \
-e 's;<\(/\)\?\(a\|a\s\+[^>]*\|sup\)>;;g' \
2021-06-08 12:09:29 +00:00
-e 's/\\$$/ /g' $< | \
2021-04-08 14:38:16 +00:00
$( GOMD2MAN) -in /dev/stdin -out $( subst source/markdown,build/man,$@ )
.PHONY : docdir
docdir :
mkdir -p docs/build/man
.PHONY : docs
docs : $( MANPAGES ) ## Generate documentation
2021-04-08 18:30:40 +00:00
# docs/remote-docs.sh requires a locally executable 'podman-remote' binary
# in addition to the target-archetecture binary (if any).
install-podman-remote-%-docs : podman -remote -$( shell env -i HOME =$ $ HOME PATH =$ $ PATH go env GOOS ) docs $( MANPAGES )
2021-04-08 14:38:16 +00:00
rm -rf docs/build/remote
mkdir -p docs/build/remote
ln -sf $( CURDIR) /docs/source/markdown/links docs/build/man/
docs/remote-docs.sh \
$* \
docs/build/remote/$* \
$( if $( findstring windows,$* ) ,docs/source/markdown,docs/build/man)
.PHONY : man -page -check
man-page-check : bin /podman
hack/man-page-checker
hack/xref-helpmsgs-manpages
.PHONY : swagger -check
swagger-check :
hack/swagger-check
2020-01-17 15:41:40 +00:00
.PHONY : swagger
swagger : pkg /api /swagger .yaml
2021-04-08 14:38:16 +00:00
.PHONY : docker -docs
docker-docs : docs
( cd docs; ./dckrman.sh ./build/man/*.1)
# Workaround vim syntax highlighting bug: "
###
### Utility and Testing targets
###
.PHONY : validate .completions
validate.completions : SHELL :=/usr /bin /env bash # Set shell to bash for this target
validate.completions :
# Check if the files can be loaded by the shell
. completions/bash/podman
if [ -x /bin/zsh ] ; then /bin/zsh completions/zsh/_podman; fi
if [ -x /bin/fish ] ; then /bin/fish completions/fish/podman.fish; fi
2021-08-09 19:04:31 +00:00
# Note: Assumes test/python/requirements.txt is installed & available
2021-04-08 14:38:16 +00:00
.PHONY : run -docker -py -tests
run-docker-py-tests :
2021-08-09 19:04:31 +00:00
touch test/__init__.py
pytest test/python/docker/
-rm test/__init__.py
2017-11-01 15:24:59 +00:00
2020-01-29 18:15:24 +00:00
.PHONY : localunit
2021-09-16 20:15:28 +00:00
localunit : test /goecho /goecho test /version /version
2020-07-21 12:54:57 +00:00
rm -rf ${ COVERAGE_PATH } && mkdir -p ${ COVERAGE_PATH }
2020-08-11 18:47:38 +00:00
$( GOBIN) /ginkgo \
2019-04-03 10:32:49 +00:00
-r \
2019-12-16 12:52:22 +00:00
$( TESTFLAGS) \
2020-11-18 21:12:33 +00:00
--skipPackage test/e2e,pkg/apparmor,pkg/bindings,hack \
2019-04-03 10:32:49 +00:00
--cover \
--covermode atomic \
2020-07-21 12:54:57 +00:00
--coverprofile coverprofile \
--outputdir ${ COVERAGE_PATH } \
2019-04-03 10:32:49 +00:00
--tags " $( BUILDTAGS) " \
--succinct
2020-07-21 12:54:57 +00:00
$( GO) tool cover -html= ${ COVERAGE_PATH } /coverprofile -o ${ COVERAGE_PATH } /coverage.html
$( GO) tool cover -func= ${ COVERAGE_PATH } /coverprofile > ${ COVERAGE_PATH } /functions
cat ${ COVERAGE_PATH } /functions | sed -n 's/\(total:\).*\([0-9][0-9].[0-9]\)/\1 \2/p'
2017-11-01 15:24:59 +00:00
2020-09-14 15:43:11 +00:00
.PHONY : test
test : localunit localintegration remoteintegration localsystem remotesystem ## Run unit, integration, and system tests.
2021-02-02 15:58:21 +00:00
.PHONY : ginkgo -run
ginkgo-run :
$( GOBIN) /ginkgo -v $( TESTFLAGS) -tags " $( TAGS) " $( GINKGOTIMEOUT) -cover -flakeAttempts 3 -progress -trace -noColor -nodes 3 -debug test/e2e/. $( HACK)
2020-01-29 18:15:24 +00:00
.PHONY : ginkgo
2018-01-24 14:45:55 +00:00
ginkgo :
2021-02-02 15:58:21 +00:00
$( MAKE) ginkgo-run TAGS = " $( BUILDTAGS) " HACK = hack/.
2018-01-24 14:45:55 +00:00
2020-01-29 18:15:24 +00:00
.PHONY : ginkgo -remote
2019-01-14 19:23:13 +00:00
ginkgo-remote :
2021-02-02 15:58:21 +00:00
$( MAKE) ginkgo-run TAGS = " $( REMOTETAGS) " HACK =
2019-01-14 19:23:13 +00:00
2020-01-29 18:15:24 +00:00
.PHONY : localintegration
2020-11-18 21:12:33 +00:00
localintegration : test -binaries ginkgo
2019-05-08 20:21:33 +00:00
2020-01-29 18:15:24 +00:00
.PHONY : remoteintegration
2020-11-18 21:12:33 +00:00
remoteintegration : test -binaries ginkgo -remote
2018-05-15 01:01:08 +00:00
2020-01-29 18:15:24 +00:00
.PHONY : localsystem
2019-04-15 18:49:53 +00:00
localsystem :
2019-07-09 18:03:35 +00:00
# Wipe existing config, database, and cache: start with clean slate.
$( RM) -rf ${ HOME } /.local/share/containers ${ HOME } /.config/containers
2021-04-08 12:47:19 +00:00
if timeout -v 1 true; then PODMAN = $( CURDIR) /bin/podman bats test/system/; else echo " Skipping $@ : 'timeout -v' unavailable' " ; fi
2019-04-15 18:49:53 +00:00
2020-01-29 18:15:24 +00:00
.PHONY : remotesystem
2019-04-15 18:49:53 +00:00
remotesystem :
2019-08-07 20:24:23 +00:00
# Wipe existing config, database, and cache: start with clean slate.
$( RM) -rf ${ HOME } /.local/share/containers ${ HOME } /.config/containers
WIP: Enable (and disable) remote testing
podman-remote has not been tested. A principal part of the
problem was #5387 - the YAML I wrote did not have the
intended effect, it did not set TEST_REMOTE_CLIENT=true
and because of my multiple iterations I did not catch this
during testing.
Part 1 of this PR is to fix .cirrus.yml to enable remote tests.
Part 2 -- what I had first noticed and tried to fix -- is that
rootless_test.sh was never running remote because, of course,
envariables are not sent via ssh. I reworked integration_test.sh
and rootless_test.sh to use a command-line decision instead.
Part 3, sigh, is to disable one failing integration test
and *all* system tests, because so many of the latter are
failing. Addressing those failures needs to be done in
subsequent PRs. Issues #6538, #6539, #6540 are filed for
some of the problems I isolated. There will be more.
Also, minor, fixed some stale references to varlink.
Signed-off-by: Ed Santiago <santiago@redhat.com>
2020-06-08 20:57:37 +00:00
# Start podman server using tmp socket; loop-wait for it;
2019-08-07 20:24:23 +00:00
# test podman-remote; kill server, clean up tmp socket file.
WIP: Enable (and disable) remote testing
podman-remote has not been tested. A principal part of the
problem was #5387 - the YAML I wrote did not have the
intended effect, it did not set TEST_REMOTE_CLIENT=true
and because of my multiple iterations I did not catch this
during testing.
Part 1 of this PR is to fix .cirrus.yml to enable remote tests.
Part 2 -- what I had first noticed and tried to fix -- is that
rootless_test.sh was never running remote because, of course,
envariables are not sent via ssh. I reworked integration_test.sh
and rootless_test.sh to use a command-line decision instead.
Part 3, sigh, is to disable one failing integration test
and *all* system tests, because so many of the latter are
failing. Addressing those failures needs to be done in
subsequent PRs. Issues #6538, #6539, #6540 are filed for
some of the problems I isolated. There will be more.
Also, minor, fixed some stale references to varlink.
Signed-off-by: Ed Santiago <santiago@redhat.com>
2020-06-08 20:57:37 +00:00
# podman server spews copious unhelpful output; ignore it.
2019-08-07 20:24:23 +00:00
rc = 0; \
if timeout -v 1 true; then \
2021-04-08 18:30:40 +00:00
SOCK_FILE = $( shell mktemp --dry-run --tmpdir podman_tmp_XXXX) ; \
WIP: Enable (and disable) remote testing
podman-remote has not been tested. A principal part of the
problem was #5387 - the YAML I wrote did not have the
intended effect, it did not set TEST_REMOTE_CLIENT=true
and because of my multiple iterations I did not catch this
during testing.
Part 1 of this PR is to fix .cirrus.yml to enable remote tests.
Part 2 -- what I had first noticed and tried to fix -- is that
rootless_test.sh was never running remote because, of course,
envariables are not sent via ssh. I reworked integration_test.sh
and rootless_test.sh to use a command-line decision instead.
Part 3, sigh, is to disable one failing integration test
and *all* system tests, because so many of the latter are
failing. Addressing those failures needs to be done in
subsequent PRs. Issues #6538, #6539, #6540 are filed for
some of the problems I isolated. There will be more.
Also, minor, fixed some stale references to varlink.
Signed-off-by: Ed Santiago <santiago@redhat.com>
2020-06-08 20:57:37 +00:00
export PODMAN_SOCKET = unix:$$ SOCK_FILE; \
2020-07-28 14:36:52 +00:00
./bin/podman system service --timeout= 0 $$ PODMAN_SOCKET > $( if $( PODMAN_SERVER_LOG) ,$( PODMAN_SERVER_LOG) ,/dev/null) 2>& 1 & \
2019-08-07 20:24:23 +00:00
retry = 5; \
2020-07-28 14:36:52 +00:00
while [ $$ retry -ge 0 ] ; do \
2020-05-11 17:07:42 +00:00
echo Waiting for server...; \
2019-08-07 20:24:23 +00:00
sleep 1; \
2020-07-28 14:36:52 +00:00
./bin/podman-remote --url $$ PODMAN_SOCKET info >/dev/null 2>& 1 && break; \
2019-08-07 20:24:23 +00:00
retry = $$ ( expr $$ retry - 1) ; \
done ; \
2020-07-28 14:36:52 +00:00
if [ $$ retry -lt 0 ] ; then \
WIP: Enable (and disable) remote testing
podman-remote has not been tested. A principal part of the
problem was #5387 - the YAML I wrote did not have the
intended effect, it did not set TEST_REMOTE_CLIENT=true
and because of my multiple iterations I did not catch this
during testing.
Part 1 of this PR is to fix .cirrus.yml to enable remote tests.
Part 2 -- what I had first noticed and tried to fix -- is that
rootless_test.sh was never running remote because, of course,
envariables are not sent via ssh. I reworked integration_test.sh
and rootless_test.sh to use a command-line decision instead.
Part 3, sigh, is to disable one failing integration test
and *all* system tests, because so many of the latter are
failing. Addressing those failures needs to be done in
subsequent PRs. Issues #6538, #6539, #6540 are filed for
some of the problems I isolated. There will be more.
Also, minor, fixed some stale references to varlink.
Signed-off-by: Ed Santiago <santiago@redhat.com>
2020-06-08 20:57:37 +00:00
echo " Error: ./bin/podman system service did not come up on $$ SOCK_FILE " >& 2; \
exit 1; \
fi ; \
2021-04-08 12:47:19 +00:00
env PODMAN = " $( CURDIR) /bin/podman-remote --url $$ PODMAN_SOCKET " bats test/system/ ; \
2019-08-07 20:24:23 +00:00
rc = $$ ?; \
kill %1; \
rm -f $$ SOCK_FILE; \
else \
echo " Skipping $@ : 'timeout -v' unavailable' " ; \
fi ; \
exit $$ rc
2018-10-29 06:56:23 +00:00
2020-02-26 16:17:13 +00:00
.PHONY : localapiv 2
localapiv2 :
env PODMAN = ./bin/podman ./test/apiv2/test-apiv2
2021-05-18 00:11:50 +00:00
env PODMAN = ./bin/podman ${ PYTHON } -m unittest discover -v ./test/apiv2/python
2020-11-03 20:15:16 +00:00
env PODMAN = ./bin/podman ${ PYTHON } -m unittest discover -v ./test/python/docker
2020-02-26 16:17:13 +00:00
.PHONY : remoteapiv 2
remoteapiv2 :
true
2020-01-29 18:15:24 +00:00
.PHONY : system .test -binary
2019-02-06 18:57:46 +00:00
system.test-binary : .install .ginkgo
2018-11-16 03:19:37 +00:00
$( GO) test -c ./test/system
2020-01-29 18:15:24 +00:00
.PHONY : test -binaries
2021-09-16 20:15:28 +00:00
test-binaries : test /checkseccomp /checkseccomp test /goecho /goecho install .catatonit test /version /version
@echo " Canonical source version: $( call err_if_empty,RELEASE_VERSION) "
2017-11-01 15:24:59 +00:00
CI: smoke test: insist on adding tests on PRs
On each PR (with a few exceptions), check the list of git-touched
files, and abort if no tests are added. Include instructions
on how to bypass the check if tests really aren't needed.
Include a hardcoded exception list for PRs that only touch a
well-known subset of "safe" files: docs, .cirrus.yml, vendor,
version, hack, contrib, or *.md. This list is likely to need
tuning over time.
Add a test suite, but not one recognized by the new script
(because it's a "*.t" file), so: [NO TESTS NEEDED]
Signed-off-by: Ed Santiago <santiago@redhat.com>
2021-01-07 20:57:35 +00:00
.PHONY : tests -included
tests-included :
contrib/cirrus/pr-should-include-tests
2021-07-20 16:42:57 +00:00
.PHONY : tests -expect -exit
tests-expect-exit :
2021-08-04 21:21:39 +00:00
@if egrep --line-number 'Expect.*ExitCode' test/e2e/*.go | egrep -v ', ".*"\)' ; then \
2021-07-20 16:42:57 +00:00
echo "^^^ Unhelpful use of Expect(ExitCode())" ; \
echo " Please use '.Should(Exit(...))' pattern instead." ; \
echo " If that's not possible, please add an annotation (description) to your assertion:" ; \
echo " Expect(...).To(..., \"Friendly explanation of this check\")" ; \
exit 1; \
fi
2021-04-08 14:38:16 +00:00
###
### Release/Packaging targets
###
2020-01-08 14:06:52 +00:00
2021-09-16 20:15:28 +00:00
podman-release.tar.gz : test /version /version binaries docs ## Build all binaries, docs., and installation tree, into a tarball.
2021-04-08 18:30:40 +00:00
$( eval TMPDIR := $( shell mktemp -d podman_tmp_XXXX) )
2021-09-16 20:15:28 +00:00
$( eval SUBDIR := podman-v$( call err_if_empty,RELEASE_NUMBER) )
2019-08-01 11:31:04 +00:00
mkdir -p " $( TMPDIR) / $( SUBDIR) "
2021-09-16 20:15:28 +00:00
$( MAKE) install.bin install.remote install.man \
2021-04-08 14:38:16 +00:00
install.systemd " DESTDIR= $( TMPDIR) / $( SUBDIR) " "PREFIX=/usr"
2021-02-18 21:08:01 +00:00
tar -czvf $@ --xattrs -C " $( TMPDIR) " " ./ $( SUBDIR) "
2019-08-01 11:31:04 +00:00
-rm -rf " $( TMPDIR) "
2021-09-16 20:15:28 +00:00
podman-remote-release-%.zip : test /version /version podman -remote -% install -podman -remote -%-docs ## Build podman-remote for GOOS=%, docs., and installation zip.
2021-04-08 18:30:40 +00:00
$( eval TMPDIR := $( shell mktemp -d podman_tmp_XXXX) )
2021-09-16 20:15:28 +00:00
$( eval SUBDIR := podman-$( call err_if_empty,RELEASE_NUMBER) )
2019-08-01 11:31:04 +00:00
mkdir -p " $( TMPDIR) / $( SUBDIR) "
2021-04-08 18:30:40 +00:00
$( MAKE) \
GOOS = $* \
DESTDIR = $( TMPDIR) / \
BINDIR = $( SUBDIR) \
SELINUXOPT = "" \
install.remote-nobuild
2019-10-30 00:27:12 +00:00
cp -r ./docs/build/remote/$* " $( TMPDIR) / $( SUBDIR) /docs/ "
2020-06-24 13:47:24 +00:00
cp ./contrib/remote/containers.conf " $( TMPDIR) / $( SUBDIR) / "
2021-04-08 18:30:40 +00:00
cd " $( TMPDIR) " && \
2021-02-18 21:08:01 +00:00
zip --recurse-paths " $( CURDIR) / $@ " "./"
2019-08-01 11:31:04 +00:00
-rm -rf " $( TMPDIR) "
2021-04-08 14:38:16 +00:00
.PHONY : podman .msi
2021-09-16 20:15:28 +00:00
podman.msi : test /version /version ## Build podman-remote, package for installation on Windows
$( MAKE) podman-v$( RELEASE_NUMBER) .msi
2021-04-08 18:30:40 +00:00
podman-v$(RELEASE_NUMBER).msi : podman -remote -windows install -podman -remote -windows -docs
2021-04-08 14:38:16 +00:00
$( eval DOCFILE := docs/build/remote/windows)
find $( DOCFILE) -print | \
wixl-heat --var var.ManSourceDir --component-group ManFiles \
--directory-ref INSTALLDIR --prefix $( DOCFILE) / > \
$( DOCFILE) /pages.wsx
2021-09-16 20:15:28 +00:00
wixl -D VERSION = $( call err_if_empty,RELEASE_VERSION) -D ManSourceDir = $( DOCFILE) \
2021-04-08 14:38:16 +00:00
-o $@ contrib/msi/podman.wxs $( DOCFILE) /pages.wsx
2020-12-18 15:46:09 +00:00
2021-04-08 14:38:16 +00:00
.PHONY : package
package : ## Build rpm packages
## TODO(ssbarnea): make version number predictable, it should not change
## on each execution, producing duplicates.
rm -rf build/* *.src.rpm ~/rpmbuild/RPMS/*
./contrib/build_rpm.sh
2018-01-11 15:54:39 +00:00
2021-04-08 14:38:16 +00:00
###
### Installation targets
###
2018-03-17 14:52:54 +00:00
2021-04-08 14:38:16 +00:00
# Remember that rpms install exec to /usr/bin/podman while a `make install`
# installs them to /usr/local/bin/podman which is likely before. Always use
# a full path to test installed podman or you risk to call another executable.
.PHONY : package -install
package-install : package ## Install rpm packages
sudo ${ PKG_MANAGER } -y install ${ HOME } /rpmbuild/RPMS/*/*.rpm
/usr/bin/podman version
/usr/bin/podman info # will catch a broken conmon
Simplify Makefile help target
An in-line Python script, while flexible, is arguably
more complex and less stable than the long-lived `grep`,
`awk`, and `printf`. Make use of these simple tools
to display a column-aligned table of target and description
help output.
Also, the first target that appears in a Makefile is considered
the default (when no target is specified on the command-line).
However, despite it's name, the `default` target was not listed
first. Fix this, and redefine "default" target to "all" as
intended, instead of "help".
Lastly, add a small workaround for a vim syntax-hilighting bug.
Signed-off-by: Chris Evich <cevich@redhat.com>
2021-04-08 12:55:56 +00:00
2020-01-29 18:15:24 +00:00
.PHONY : install
2021-06-28 18:16:50 +00:00
install : .gopathok install .bin install .remote install .man install .systemd ## Install binaries to system locations
2019-05-17 15:40:45 +00:00
2021-04-08 14:38:16 +00:00
.PHONY : install .catatonit
install.catatonit :
./hack/install_catatonit.sh
2020-04-23 15:57:20 +00:00
.PHONY : install .remote -nobuild
install.remote-nobuild :
2019-06-07 05:46:41 +00:00
install ${ SELINUXOPT } -d -m 755 $( DESTDIR) $( BINDIR)
2021-04-08 18:30:40 +00:00
install ${ SELINUXOPT } -m 755 $( SRCBINDIR) /podman$( BINSFX) \
$( DESTDIR) $( BINDIR) /podman$( BINSFX)
test -z " ${ SELINUXOPT } " || \
chcon --verbose --reference= $( DESTDIR) $( BINDIR) /podman-remote \
bin/podman-remote
2017-11-01 15:24:59 +00:00
2020-04-23 15:57:20 +00:00
.PHONY : install .remote
install.remote : podman -remote install .remote -nobuild
.PHONY : install .bin -nobuild
install.bin-nobuild :
2019-06-07 05:46:41 +00:00
install ${ SELINUXOPT } -d -m 755 $( DESTDIR) $( BINDIR)
install ${ SELINUXOPT } -m 755 bin/podman $( DESTDIR) $( BINDIR) /podman
test -z " ${ SELINUXOPT } " || chcon --verbose --reference= $( DESTDIR) $( BINDIR) /podman bin/podman
2020-11-04 14:51:26 +00:00
install ${ SELINUXOPT } -m 755 -d ${ DESTDIR } ${ TMPFILESDIR }
install ${ SELINUXOPT } -m 644 contrib/tmpfile/podman.conf ${ DESTDIR } ${ TMPFILESDIR } /podman.conf
2017-11-01 15:24:59 +00:00
2020-04-23 15:57:20 +00:00
.PHONY : install .bin
install.bin : podman install .bin -nobuild
.PHONY : install .man -nobuild
install.man-nobuild :
2019-06-07 05:46:41 +00:00
install ${ SELINUXOPT } -d -m 755 $( DESTDIR) $( MANDIR) /man1
install ${ SELINUXOPT } -d -m 755 $( DESTDIR) $( MANDIR) /man5
2019-10-24 19:54:57 +00:00
install ${ SELINUXOPT } -m 644 $( filter %.1,$( MANPAGES_DEST) ) -t $( DESTDIR) $( MANDIR) /man1
install ${ SELINUXOPT } -m 644 $( filter %.5,$( MANPAGES_DEST) ) -t $( DESTDIR) $( MANDIR) /man5
2019-10-30 00:27:12 +00:00
install ${ SELINUXOPT } -m 644 docs/source/markdown/links/*1 -t $( DESTDIR) $( MANDIR) /man1
2017-11-01 15:24:59 +00:00
2020-04-23 15:57:20 +00:00
.PHONY : install .man
install.man : docs install .man -nobuild
2020-01-29 18:15:24 +00:00
.PHONY : install .completions
2017-11-01 15:24:59 +00:00
install.completions :
2019-06-07 05:46:41 +00:00
install ${ SELINUXOPT } -d -m 755 ${ DESTDIR } ${ BASHINSTALLDIR }
install ${ SELINUXOPT } -m 644 completions/bash/podman ${ DESTDIR } ${ BASHINSTALLDIR }
2020-11-08 20:50:51 +00:00
install ${ SELINUXOPT } -m 644 completions/bash/podman-remote ${ DESTDIR } ${ BASHINSTALLDIR }
2019-06-07 05:46:41 +00:00
install ${ SELINUXOPT } -d -m 755 ${ DESTDIR } ${ ZSHINSTALLDIR }
install ${ SELINUXOPT } -m 644 completions/zsh/_podman ${ DESTDIR } ${ ZSHINSTALLDIR }
2020-11-08 20:50:51 +00:00
install ${ SELINUXOPT } -m 644 completions/zsh/_podman-remote ${ DESTDIR } ${ ZSHINSTALLDIR }
install ${ SELINUXOPT } -d -m 755 ${ DESTDIR } ${ FISHINSTALLDIR }
install ${ SELINUXOPT } -m 644 completions/fish/podman.fish ${ DESTDIR } ${ FISHINSTALLDIR }
install ${ SELINUXOPT } -m 644 completions/fish/podman-remote.fish ${ DESTDIR } ${ FISHINSTALLDIR }
2021-02-10 16:57:11 +00:00
# There is no common location for powershell files so do not install them. Users have to source the file from their powershell profile.
2017-11-01 15:24:59 +00:00
2020-01-29 18:15:24 +00:00
.PHONY : install .docker
2021-03-01 14:02:27 +00:00
install.docker :
2021-03-30 22:33:46 +00:00
install ${ SELINUXOPT } -d -m 755 $( DESTDIR) $( BINDIR)
2019-06-07 05:46:41 +00:00
install ${ SELINUXOPT } -m 755 docker $( DESTDIR) $( BINDIR) /docker
2020-01-27 14:52:11 +00:00
install ${ SELINUXOPT } -m 755 -d ${ DESTDIR } ${ SYSTEMDDIR } ${ DESTDIR } ${ USERSYSTEMDDIR } ${ DESTDIR } ${ TMPFILESDIR }
install ${ SELINUXOPT } -m 644 contrib/systemd/system/podman-docker.conf -t ${ DESTDIR } ${ TMPFILESDIR }
2018-01-11 15:54:39 +00:00
2021-03-03 20:53:44 +00:00
.PHONY : install .docker -docs -nobuild
install.docker-docs-nobuild :
2021-03-30 22:33:46 +00:00
install ${ SELINUXOPT } -d -m 755 $( DESTDIR) $( MANDIR) /man1
2021-03-01 14:02:27 +00:00
install ${ SELINUXOPT } -m 644 docs/build/man/docker*.1 -t $( DESTDIR) $( MANDIR) /man1
2021-03-03 20:53:44 +00:00
.PHONY : install .docker -docs
install.docker-docs : docker -docs install .docker -docs -nobuild
2021-03-30 22:35:26 +00:00
.PHONY : install .docker -full
install.docker-full : install .docker install .docker -docs
2020-05-29 18:38:33 +00:00
.PHONY : install .systemd
2021-03-02 12:27:15 +00:00
i f n e q ( , $( findstring systemd ,$ ( BUILDTAGS ) ) )
2020-11-18 21:12:33 +00:00
install.systemd :
2020-06-17 19:58:11 +00:00
install ${ SELINUXOPT } -m 755 -d ${ DESTDIR } ${ SYSTEMDDIR } ${ DESTDIR } ${ USERSYSTEMDDIR }
2020-08-03 11:11:36 +00:00
# User services
install ${ SELINUXOPT } -m 644 contrib/systemd/auto-update/podman-auto-update.service ${ DESTDIR } ${ USERSYSTEMDDIR } /podman-auto-update.service
install ${ SELINUXOPT } -m 644 contrib/systemd/auto-update/podman-auto-update.timer ${ DESTDIR } ${ USERSYSTEMDDIR } /podman-auto-update.timer
2020-03-20 10:45:45 +00:00
install ${ SELINUXOPT } -m 644 contrib/systemd/user/podman.socket ${ DESTDIR } ${ USERSYSTEMDDIR } /podman.socket
install ${ SELINUXOPT } -m 644 contrib/systemd/user/podman.service ${ DESTDIR } ${ USERSYSTEMDDIR } /podman.service
2021-06-07 21:41:10 +00:00
install ${ SELINUXOPT } -m 644 contrib/systemd/user/podman-restart.service ${ DESTDIR } ${ USERSYSTEMDDIR } /podman-restart.service
2020-08-03 11:11:36 +00:00
# System services
2020-07-07 15:56:56 +00:00
install ${ SELINUXOPT } -m 644 contrib/systemd/auto-update/podman-auto-update.service ${ DESTDIR } ${ SYSTEMDDIR } /podman-auto-update.service
install ${ SELINUXOPT } -m 644 contrib/systemd/auto-update/podman-auto-update.timer ${ DESTDIR } ${ SYSTEMDDIR } /podman-auto-update.timer
2020-03-20 10:45:45 +00:00
install ${ SELINUXOPT } -m 644 contrib/systemd/system/podman.socket ${ DESTDIR } ${ SYSTEMDDIR } /podman.socket
install ${ SELINUXOPT } -m 644 contrib/systemd/system/podman.service ${ DESTDIR } ${ SYSTEMDDIR } /podman.service
2021-06-07 21:41:10 +00:00
install ${ SELINUXOPT } -m 644 contrib/systemd/system/podman-restart.service ${ DESTDIR } ${ SYSTEMDDIR } /podman-restart.service
2021-03-02 12:27:15 +00:00
e l s e
install.systemd :
e n d i f
2018-03-26 14:39:14 +00:00
2017-11-01 15:24:59 +00:00
.PHONY : install .tools
2020-12-18 15:46:09 +00:00
install.tools : .install .goimports .install .gitvalidation .install .md 2man .install .ginkgo .install .golangci -lint .install .bats ## Install needed tools
2018-09-13 19:12:04 +00:00
2020-12-18 15:46:09 +00:00
.install.goimports : .gopathok
if [ ! -x " $( GOBIN) /goimports " ] ; then \
$( call go-get,golang.org/x/tools/cmd/goimports) ; \
fi
touch .install.goimports
2020-01-29 18:15:24 +00:00
.PHONY : .install .ginkgo
2018-09-13 19:12:04 +00:00
.install.ginkgo : .gopathok
if [ ! -x " $( GOBIN) /ginkgo " ] ; then \
2021-01-20 09:31:18 +00:00
$( GO) install $( BUILDFLAGS) ./vendor/github.com/onsi/ginkgo/ginkgo ; \
2018-09-13 19:12:04 +00:00
fi
2017-11-01 15:24:59 +00:00
2020-01-29 18:15:24 +00:00
.PHONY : .install .gitvalidation
2017-11-01 15:24:59 +00:00
.install.gitvalidation : .gopathok
Makefile: Respect GOBIN
And use 'go env GOBIN' to detect the user's existing preference. From
[1]:
> The bin directory holds compiled commands. Each command is named
> for its source directory, but only the final element, not the entire
> path. That is, the command with source in DIR/src/foo/quux is
> installed into DIR/bin/quux, not DIR/bin/foo/quux. The "foo/"
> prefix is stripped so that you can add DIR/bin to your PATH to get
> at the installed commands. If the GOBIN environment variable is
> set, commands are installed to the directory it names instead of
> DIR/bin. GOBIN must be an absolute path.
> ...
> Go searches each directory listed in GOPATH to find source code, but
> new packages are always downloaded into the first directory in the
> list.
So if GOBIN is set, it will be non-empty, and we can use $(GOBIN)/...
If GOBIN is unset, 'go env GOBIN' will return an empty string (as it
does on Travis [2]). In that case, I'm assuming that the package in
question is in the first directory in GOPATH and using the new
FIRST_GOPATH (firstword and subst are documented in [3]). That's
probably fairly safe, since our previous GOPATH handling assumed it
only contained a single path, and nobody was complaining about that.
Using ?= allows us to skip the 'dirname' call if we end up not needing
GOPKGBASEDIR [4] (e.g. for the 'help' target). The recursive
expansion could cause an issue if the result of the shell expansions
included a '$', but those seem unlikely in GOPKGBASEDIR, GOMD2MAN, or
the manpage paths. I haven't used ?= for GOBIN, because we'll always
need the expanded value for the if check.
Using GOMD2MAN allows us to collapse old ||-based recipe into a less
confusing invocation. And using a static pattern rule [5] for
$(MANPAGES) lets us write a single rule to handle both section 1 and
section 5.
While I was updating the GOPATH handling, I moved .gopathok from the
possibly-shared $(GOPATH)/.gopathok to the
definitely-specific-to-this-project .gopathok. That may cause some
issues if you rebuild after changing your GOPATH without calling
'clean', but I don't expect folks to change their GOPATH frequently.
And the old approach would fail if different consumers were also using
the same flag path to mean something else (as CRI-O does [6]).
As part of cleaning up .gopathok, I've also collapsed clean's rm calls
into a single invocation. That will give us the same results with
less process setup/teardown penalties.
[1]: https://golang.org/cmd/go/#hdr-GOPATH_environment_variable
[2]: https://travis-ci.org/projectatomic/libpod/jobs/379345071#L459
[3]: https://www.gnu.org/software/make/manual/html_node/Text-Functions.html
[4]: https://www.gnu.org/software/make/manual/html_node/Setting.html
[5]: https://www.gnu.org/software/make/manual/html_node/Static-Usage.html
[6]: https://github.com/kubernetes-incubator/cri-o/blob/v1.10.1/Makefile#L62
Signed-off-by: W. Trevor King <wking@tremily.us>
Closes: #774
Approved by: mheon
2018-05-15 17:50:56 +00:00
if [ ! -x " $( GOBIN) /git-validation " ] ; then \
2019-06-24 09:15:31 +00:00
$( call go-get,github.com/vbatts/git-validation) ; \
2017-11-01 15:24:59 +00:00
fi
2020-01-29 18:15:24 +00:00
.PHONY : .install .golangci -lint
2019-07-22 18:08:06 +00:00
.install.golangci-lint : .gopathok
2021-02-09 18:23:32 +00:00
VERSION = 1.36.0 GOBIN = $( GOBIN) sh ./hack/install_golangci.sh
2019-07-22 18:08:06 +00:00
2020-06-08 10:33:35 +00:00
.PHONY : .install .bats
.install.bats : .gopathok
VERSION = v1.1.0 ./hack/install_bats.sh
2020-02-18 14:28:47 +00:00
.PHONY : .install .pre -commit
.install.pre-commit :
if [ -z " $( PRE_COMMIT) " ] ; then \
python3 -m pip install --user pre-commit; \
fi
2020-01-29 18:15:24 +00:00
.PHONY : .install .md 2man
2017-11-01 15:24:59 +00:00
.install.md2man : .gopathok
2019-12-03 19:47:33 +00:00
if [ ! -x " $( GOMD2MAN) " ] ; then \
$( call go-get,github.com/cpuguy83/go-md2man) ; \
2017-11-01 15:24:59 +00:00
fi
2020-05-29 18:38:33 +00:00
# $BUILD_TAGS variable is used in hack/golangci-lint.sh
2018-04-28 16:45:51 +00:00
.PHONY : install .libseccomp .sudo
install.libseccomp.sudo :
2018-04-25 18:26:52 +00:00
rm -rf ../../seccomp/libseccomp
git clone https://github.com/seccomp/libseccomp ../../seccomp/libseccomp
2019-12-04 10:11:31 +00:00
cd ../../seccomp/libseccomp && git checkout --detach $( LIBSECCOMP_COMMIT) && ./autogen.sh && ./configure --prefix= /usr && make all && make install
2018-04-25 18:26:52 +00:00
2021-04-08 14:38:16 +00:00
.PHONY : uninstall
uninstall :
for i in $( filter %.1,$( MANPAGES_DEST) ) ; do \
rm -f $( DESTDIR) $( MANDIR) /man1/$$ ( basename $$ { i} ) ; \
done ; \
for i in $( filter %.5,$( MANPAGES_DEST) ) ; do \
rm -f $( DESTDIR) $( MANDIR) /man5/$$ ( basename $$ { i} ) ; \
2021-02-01 20:37:05 +00:00
done
2021-04-08 14:38:16 +00:00
# Remove podman and remote bin
rm -f $( DESTDIR) $( BINDIR) /podman
rm -f $( DESTDIR) $( BINDIR) /podman-remote
# Remove related config files
rm -f ${ DESTDIR } ${ ETCDIR } /cni/net.d/87-podman-bridge.conflist
rm -f ${ DESTDIR } ${ TMPFILESDIR } /podman.conf
rm -f ${ DESTDIR } ${ SYSTEMDDIR } /io.podman.socket
rm -f ${ DESTDIR } ${ USERSYSTEMDDIR } /io.podman.socket
rm -f ${ DESTDIR } ${ SYSTEMDDIR } /io.podman.service
rm -f ${ DESTDIR } ${ SYSTEMDDIR } /podman.service
rm -f ${ DESTDIR } ${ SYSTEMDDIR } /podman.socket
rm -f ${ DESTDIR } ${ USERSYSTEMDDIR } /podman.socket
rm -f ${ DESTDIR } ${ USERSYSTEMDDIR } /podman.service
2021-02-01 20:37:05 +00:00
2021-04-08 14:38:16 +00:00
.PHONY : clean
2021-04-08 18:30:40 +00:00
clean : ## Clean all make artifacts
2021-04-08 14:38:16 +00:00
rm -rf \
.gopathok \
_output \
2021-04-08 18:30:40 +00:00
$( wildcard podman-*.msi) \
2021-04-08 14:38:16 +00:00
$( wildcard podman-remote*.zip) \
2021-04-08 18:30:40 +00:00
$( wildcard podman_tmp_*) \
2021-04-08 14:38:16 +00:00
$( wildcard podman*.tar.gz) \
bin \
build \
test/checkseccomp/checkseccomp \
test/goecho/goecho \
2021-09-16 20:15:28 +00:00
test/version/version \
2021-08-09 19:04:31 +00:00
test/__init__.py \
2021-04-08 14:38:16 +00:00
test/testdata/redis-image \
libpod/container_ffjson.go \
libpod/pod_ffjson.go \
libpod/container_easyjson.go \
libpod/pod_easyjson.go \
.install.goimports \
2021-08-09 19:04:31 +00:00
docs/build \
venv
2021-04-08 14:38:16 +00:00
make -C docs clean