Compare commits
62 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
942d58d41c | ||
|
|
2161f09276 | ||
|
|
ded61bee62 | ||
|
|
1955b5d544 | ||
|
|
a987bf649c | ||
|
|
f13f2a3ba2 | ||
|
|
70b5176a33 | ||
|
|
8a21f07632 | ||
|
|
6c752ebebf | ||
|
|
2ef9e11aea | ||
|
|
11e2200ff9 | ||
|
|
9a816a1b8e | ||
|
|
e8d882cc13 | ||
|
|
fad19dd8f2 | ||
|
|
8ef19c101a | ||
|
|
d9f2e08b51 | ||
|
|
c0f72b3e03 | ||
|
|
3222a2a4d1 | ||
|
|
b5b47d41e6 | ||
|
|
c093d6a845 | ||
|
|
6129365a19 | ||
|
|
6b23c4d84a | ||
|
|
76ad69ccc8 | ||
|
|
ecfb0040de | ||
|
|
7727884c55 | ||
|
|
98dffa5af5 | ||
|
|
e297613194 | ||
|
|
ae1d652f70 | ||
|
|
d66c563c31 | ||
|
|
4927c6577c | ||
|
|
9d8c463a7f | ||
|
|
c6d67f583c | ||
|
|
6cb20272e4 | ||
|
|
f44e9891d1 | ||
|
|
bf242e8a52 | ||
|
|
db6f2bceb9 | ||
|
|
f1423ae0b2 | ||
|
|
f88c1a43bd | ||
|
|
5b28cca4e1 | ||
|
|
4fbe33bdbd | ||
|
|
4c1af406f7 | ||
|
|
51ce5e4e0a | ||
|
|
75bdc3196f | ||
|
|
d36e05d452 | ||
|
|
29a806305e | ||
|
|
19a7e501be | ||
|
|
b591a3d7c5 | ||
|
|
b21181a446 | ||
|
|
c80dfffa14 | ||
|
|
cbb3eb0e22 | ||
|
|
98e2bee2a5 | ||
|
|
4b25e62b52 | ||
|
|
1c08727c5d | ||
|
|
af84720d71 | ||
|
|
c748c4f928 | ||
|
|
5164551f98 | ||
|
|
63b00ad2e7 | ||
|
|
2bda4c3be6 | ||
|
|
3b72178739 | ||
|
|
df8f46eb2d | ||
|
|
a1931efcc1 | ||
|
|
3d6603945d |
@@ -1,28 +1,42 @@
|
|||||||
---
|
---
|
||||||
|
|
||||||
stages:
|
default:
|
||||||
- build
|
image: quay.io/buildah/stable:v1.31.0
|
||||||
|
|
||||||
build:
|
|
||||||
stage: build
|
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
- linux
|
- linux
|
||||||
image:
|
|
||||||
name: gcr.io/kaniko-project/executor:v1.6.0-debug
|
envars:
|
||||||
entrypoint: ["/busybox/sh", "-c"]
|
stage: test
|
||||||
|
script: |
|
||||||
|
echo "Select CI env. vars.:";
|
||||||
|
printenv | egrep '^CI_' | sort
|
||||||
|
|
||||||
|
commit_check:
|
||||||
|
stage: test
|
||||||
variables:
|
variables:
|
||||||
BASE_TAG: latest
|
BADRX: '^(squash!)|(fixup!)'
|
||||||
FLAVOR: stable
|
script: |
|
||||||
|
dnf install -y git
|
||||||
|
shortlogtmp=$(mktemp -p '' commit_check_tmp_XXXX)
|
||||||
|
git log --oneline --no-show-signature "${CI_MERGE_REQUEST_DIFF_BASE_SHA}..HEAD" > "$shortlogtmp"
|
||||||
|
if egrep -q "$BADRX" "$shortlogtmp"; then
|
||||||
|
egrep "$BADRX" "$shortlogtmp"
|
||||||
|
die "Found the above commits matching '$BADRX'"
|
||||||
|
fi
|
||||||
|
|
||||||
|
build:
|
||||||
|
stage: deploy
|
||||||
|
variables:
|
||||||
|
BUILDAH_FORMAT: docker
|
||||||
|
BUILDAH_ISOLATION: chroot
|
||||||
|
STORAGE_DRIVER: vfs
|
||||||
|
before_script:
|
||||||
|
- echo "$CI_REGISTRY_PASSWORD" | buildah login -u "$CI_REGISTRY_USER" --password-stdin $CI_REGISTRY
|
||||||
script:
|
script:
|
||||||
- 'mkdir -p /kaniko/.docker'
|
|
||||||
- 'echo "{\"auths\":{\"$CI_REGISTRY\":{\"username\":\"$CI_REGISTRY_USER\",\"password\":\"$CI_REGISTRY_PASSWORD\"}}}" > /kaniko/.docker/config.json'
|
|
||||||
- |
|
|
||||||
echo "Select CI env. vars.:";
|
|
||||||
printenv | egrep '^CI_' | sort
|
|
||||||
# N/B: There could be more than one merge-request open with this branch's HEAD
|
# N/B: There could be more than one merge-request open with this branch's HEAD
|
||||||
- |
|
- |
|
||||||
IMAGE_TAG="${CI_COMMIT_BRANCH}";
|
IMAGE_TAG="${CI_COMMIT_REF_SLUG}";
|
||||||
if [[ -n "$CI_COMMIT_TAG" ]]; then
|
if [[ -n "$CI_COMMIT_TAG" ]]; then
|
||||||
IMAGE_TAG="${CI_COMMIT_TAG}";
|
IMAGE_TAG="${CI_COMMIT_TAG}";
|
||||||
elif [[ -n "$CI_OPEN_MERGE_REQUESTS" ]]; then
|
elif [[ -n "$CI_OPEN_MERGE_REQUESTS" ]]; then
|
||||||
@@ -31,10 +45,12 @@ build:
|
|||||||
IMAGE_TAG="latest";
|
IMAGE_TAG="latest";
|
||||||
fi
|
fi
|
||||||
echo "Building/Pushing to: ${CI_REGISTRY_IMAGE}:${IMAGE_TAG}";
|
echo "Building/Pushing to: ${CI_REGISTRY_IMAGE}:${IMAGE_TAG}";
|
||||||
- |
|
- >-
|
||||||
/kaniko/executor \
|
buildah build \
|
||||||
--context $CI_PROJECT_DIR \
|
--label "org.opencontainers.image.source=${CI_PROJECT_URL}" \
|
||||||
--dockerfile $CI_PROJECT_DIR/Containerfile \
|
--label "org.opencontainers.image.revision=$CI_COMMIT_SHA" \
|
||||||
--destination "${CI_REGISTRY_IMAGE}:${IMAGE_TAG}" \
|
--label "org.opencontainers.image.created=$CI_JOB_STARTED_AT" \
|
||||||
--build-arg "BASE_TAG=$BASE_TAG" \
|
--label "org.opencontainers.image.version=${IMAGE_TAG}" \
|
||||||
--build-arg "FLAVOR=$FLAVOR"
|
-t "${CI_REGISTRY_IMAGE}:${IMAGE_TAG}" "$CI_PROJECT_DIR"
|
||||||
|
- buildah images
|
||||||
|
- buildah push "${CI_REGISTRY_IMAGE}:${IMAGE_TAG}"
|
||||||
|
|||||||
674
COPYING
Normal file
674
COPYING
Normal file
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
165
COPYING.LESSER
Normal file
165
COPYING.LESSER
Normal file
@@ -0,0 +1,165 @@
|
|||||||
|
GNU LESSER GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
|
||||||
|
This version of the GNU Lesser General Public License incorporates
|
||||||
|
the terms and conditions of version 3 of the GNU General Public
|
||||||
|
License, supplemented by the additional permissions listed below.
|
||||||
|
|
||||||
|
0. Additional Definitions.
|
||||||
|
|
||||||
|
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||||
|
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||||
|
General Public License.
|
||||||
|
|
||||||
|
"The Library" refers to a covered work governed by this License,
|
||||||
|
other than an Application or a Combined Work as defined below.
|
||||||
|
|
||||||
|
An "Application" is any work that makes use of an interface provided
|
||||||
|
by the Library, but which is not otherwise based on the Library.
|
||||||
|
Defining a subclass of a class defined by the Library is deemed a mode
|
||||||
|
of using an interface provided by the Library.
|
||||||
|
|
||||||
|
A "Combined Work" is a work produced by combining or linking an
|
||||||
|
Application with the Library. The particular version of the Library
|
||||||
|
with which the Combined Work was made is also called the "Linked
|
||||||
|
Version".
|
||||||
|
|
||||||
|
The "Minimal Corresponding Source" for a Combined Work means the
|
||||||
|
Corresponding Source for the Combined Work, excluding any source code
|
||||||
|
for portions of the Combined Work that, considered in isolation, are
|
||||||
|
based on the Application, and not on the Linked Version.
|
||||||
|
|
||||||
|
The "Corresponding Application Code" for a Combined Work means the
|
||||||
|
object code and/or source code for the Application, including any data
|
||||||
|
and utility programs needed for reproducing the Combined Work from the
|
||||||
|
Application, but excluding the System Libraries of the Combined Work.
|
||||||
|
|
||||||
|
1. Exception to Section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
You may convey a covered work under sections 3 and 4 of this License
|
||||||
|
without being bound by section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
2. Conveying Modified Versions.
|
||||||
|
|
||||||
|
If you modify a copy of the Library, and, in your modifications, a
|
||||||
|
facility refers to a function or data to be supplied by an Application
|
||||||
|
that uses the facility (other than as an argument passed when the
|
||||||
|
facility is invoked), then you may convey a copy of the modified
|
||||||
|
version:
|
||||||
|
|
||||||
|
a) under this License, provided that you make a good faith effort to
|
||||||
|
ensure that, in the event an Application does not supply the
|
||||||
|
function or data, the facility still operates, and performs
|
||||||
|
whatever part of its purpose remains meaningful, or
|
||||||
|
|
||||||
|
b) under the GNU GPL, with none of the additional permissions of
|
||||||
|
this License applicable to that copy.
|
||||||
|
|
||||||
|
3. Object Code Incorporating Material from Library Header Files.
|
||||||
|
|
||||||
|
The object code form of an Application may incorporate material from
|
||||||
|
a header file that is part of the Library. You may convey such object
|
||||||
|
code under terms of your choice, provided that, if the incorporated
|
||||||
|
material is not limited to numerical parameters, data structure
|
||||||
|
layouts and accessors, or small macros, inline functions and templates
|
||||||
|
(ten or fewer lines in length), you do both of the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the object code that the
|
||||||
|
Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
4. Combined Works.
|
||||||
|
|
||||||
|
You may convey a Combined Work under terms of your choice that,
|
||||||
|
taken together, effectively do not restrict modification of the
|
||||||
|
portions of the Library contained in the Combined Work and reverse
|
||||||
|
engineering for debugging such modifications, if you also do each of
|
||||||
|
the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the Combined Work that
|
||||||
|
the Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
c) For a Combined Work that displays copyright notices during
|
||||||
|
execution, include the copyright notice for the Library among
|
||||||
|
these notices, as well as a reference directing the user to the
|
||||||
|
copies of the GNU GPL and this license document.
|
||||||
|
|
||||||
|
d) Do one of the following:
|
||||||
|
|
||||||
|
0) Convey the Minimal Corresponding Source under the terms of this
|
||||||
|
License, and the Corresponding Application Code in a form
|
||||||
|
suitable for, and under terms that permit, the user to
|
||||||
|
recombine or relink the Application with a modified version of
|
||||||
|
the Linked Version to produce a modified Combined Work, in the
|
||||||
|
manner specified by section 6 of the GNU GPL for conveying
|
||||||
|
Corresponding Source.
|
||||||
|
|
||||||
|
1) Use a suitable shared library mechanism for linking with the
|
||||||
|
Library. A suitable mechanism is one that (a) uses at run time
|
||||||
|
a copy of the Library already present on the user's computer
|
||||||
|
system, and (b) will operate properly with a modified version
|
||||||
|
of the Library that is interface-compatible with the Linked
|
||||||
|
Version.
|
||||||
|
|
||||||
|
e) Provide Installation Information, but only if you would otherwise
|
||||||
|
be required to provide such information under section 6 of the
|
||||||
|
GNU GPL, and only to the extent that such information is
|
||||||
|
necessary to install and execute a modified version of the
|
||||||
|
Combined Work produced by recombining or relinking the
|
||||||
|
Application with a modified version of the Linked Version. (If
|
||||||
|
you use option 4d0, the Installation Information must accompany
|
||||||
|
the Minimal Corresponding Source and Corresponding Application
|
||||||
|
Code. If you use option 4d1, you must provide the Installation
|
||||||
|
Information in the manner specified by section 6 of the GNU GPL
|
||||||
|
for conveying Corresponding Source.)
|
||||||
|
|
||||||
|
5. Combined Libraries.
|
||||||
|
|
||||||
|
You may place library facilities that are a work based on the
|
||||||
|
Library side by side in a single library together with other library
|
||||||
|
facilities that are not Applications and are not covered by this
|
||||||
|
License, and convey such a combined library under terms of your
|
||||||
|
choice, if you do both of the following:
|
||||||
|
|
||||||
|
a) Accompany the combined library with a copy of the same work based
|
||||||
|
on the Library, uncombined with any other library facilities,
|
||||||
|
conveyed under the terms of this License.
|
||||||
|
|
||||||
|
b) Give prominent notice with the combined library that part of it
|
||||||
|
is a work based on the Library, and explaining where to find the
|
||||||
|
accompanying uncombined form of the same work.
|
||||||
|
|
||||||
|
6. Revised Versions of the GNU Lesser General Public License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU Lesser General Public License from time to time. Such new
|
||||||
|
versions will be similar in spirit to the present version, but may
|
||||||
|
differ in detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Library as you received it specifies that a certain numbered version
|
||||||
|
of the GNU Lesser General Public License "or any later version"
|
||||||
|
applies to it, you have the option of following the terms and
|
||||||
|
conditions either of that published version or of any later version
|
||||||
|
published by the Free Software Foundation. If the Library as you
|
||||||
|
received it does not specify a version number of the GNU Lesser
|
||||||
|
General Public License, you may choose any version of the GNU Lesser
|
||||||
|
General Public License ever published by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Library as you received it specifies that a proxy can decide
|
||||||
|
whether future versions of the GNU Lesser General Public License shall
|
||||||
|
apply, that proxy's public statement of acceptance of any version is
|
||||||
|
permanent authorization for you to choose that version for the
|
||||||
|
Library.
|
||||||
217
Containerfile
217
Containerfile
@@ -1,146 +1,95 @@
|
|||||||
# pipglr/Containerfile
|
# Rootless podman container image to run rootless GitLab Runner service.
|
||||||
|
# Copyright (C) 2023 Christopher C. Evich
|
||||||
#
|
#
|
||||||
# Builds a Podman-in-Podman Gitlab-Runner image for
|
# This program is free software: you can redistribute it and/or modify
|
||||||
# executing Gitlab CI/CD jobs. Requires configuration
|
# it under the terms of the GNU Lesser General Public License as published by
|
||||||
# steps specific to Gitlab projects. For more info. see
|
# the Free Software Foundation, either version 3 of the License, or
|
||||||
# https://docs.gitlab.com/runner/executors/docker.html#use-podman-to-run-docker-commands
|
# (at your option) any later version.
|
||||||
#
|
#
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
ARG FLAVOR="stable"
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
ARG BASE_TAG="latest"
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
FROM quay.io/podman/$FLAVOR:$BASE_TAG
|
# GNU Lesser General Public License for more details.
|
||||||
|
|
||||||
# This is a list of packages to remove and/or exclude from the image.
|
|
||||||
# Primarily this is done for security reasons, should a runner process
|
|
||||||
# escape confinement. Having fewer things to poke, lowers the attack
|
|
||||||
# surface-area.
|
|
||||||
#
|
#
|
||||||
# This list was formed manually by running these commands in the base image:
|
# You should have received a copy of the GNU Lesser General Public License
|
||||||
# for package in $(rpm -qa); do \
|
# along with this program
|
||||||
# if dnf erase $package; then echo "$package" >> exclude; fi; \
|
|
||||||
# done; \
|
|
||||||
# cat exclude
|
|
||||||
#
|
|
||||||
# After adding those packages to this file, the container build was run
|
|
||||||
# and package list adjusted, untill no dependency errors were raised.
|
|
||||||
ARG EXCLUDE_PACKAGES="\
|
|
||||||
fedora-repos-modular \
|
|
||||||
findutils \
|
|
||||||
libxcrypt-compat \
|
|
||||||
openldap-compat \
|
|
||||||
podman-gvproxy \
|
|
||||||
rootfiles \
|
|
||||||
sudo \
|
|
||||||
vim-minimal \
|
|
||||||
yum"
|
|
||||||
|
|
||||||
# Base-image runs as user 'podman', temporarily switch to root
|
FROM quay.io/centos/centos:stream9
|
||||||
# for installation/setup.
|
|
||||||
USER root
|
|
||||||
# Helper for comparison in future RUN operations (DO NOT USE)
|
|
||||||
ARG _DNFCMD="dnf --setopt=tsflags=nodocs -y"
|
|
||||||
# Set this instead, if (for example) you want to volume-mount in /var/cache/dnf
|
|
||||||
ARG DNFCMD="${_DNFCMD}"
|
|
||||||
# Avoid installing any documentation to keep image small
|
|
||||||
# During install, excluding packages is meaningless if already installed
|
|
||||||
RUN set -x && \
|
|
||||||
rm -f /etc/dnf/protected.d/sudo.conf && \
|
|
||||||
rm -f /etc/dnf/protected.d/yum.conf && \
|
|
||||||
$DNFCMD remove ${EXCLUDE_PACKAGES}
|
|
||||||
|
|
||||||
# Enable callers to customize the runner version as needed, otherwise
|
ADD /root/ /root/
|
||||||
# assume this image will be version-tagged, so it's fine to grab the latest.
|
ADD /etc/ /etc/
|
||||||
ARG RUNNER_VERSION="latest"
|
ADD /home/ /home/
|
||||||
# When building a multi-arch manifest-list, this buid-arg is set automatically.
|
|
||||||
ARG TARGETARCH="amd64"
|
|
||||||
ENV RUNNER_RPM_URL=https://gitlab-runner-downloads.s3.amazonaws.com/${RUNNER_VERSION}/rpm/gitlab-runner_${TARGETARCH}.rpm
|
|
||||||
RUN for rpm in ${EXCLUDE_PACKAGES}; do x+="--exclude=$rpm "; done && \
|
|
||||||
set -x && \
|
|
||||||
$DNFCMD update && \
|
|
||||||
$DNFCMD install $x $RUNNER_RPM_URL && \
|
|
||||||
$DNFCMD upgrade && \
|
|
||||||
if [[ "${DNFCMD}" == "${_DNFCMD}" ]]; then \
|
|
||||||
dnf clean all && \
|
|
||||||
rm -rf /var/cache/dnf; \
|
|
||||||
fi
|
|
||||||
|
|
||||||
# In case of a runner escape, prevent easy installation of packages.
|
# Allow image-builders to choose another version besides "latest" should
|
||||||
RUN rm -f /etc/dnf/protected.d/* && \
|
# an incompatible change be introduced.
|
||||||
rpm -e dnf && \
|
ARG RUNNER_VERSION=latest
|
||||||
rm -f $(type -P rpm)
|
|
||||||
|
|
||||||
ADD /config.toml /home/podman/.gitlab-runner/config.toml
|
# Permit building containers for alternate architectures. At the time
|
||||||
# The global "listen_address" option is used for metrics and
|
# of this commit, only 'arm64' is available.
|
||||||
# debugging. Disable it by default since use requires special/
|
ARG TARGETARCH=amd64
|
||||||
# additional host configuration.
|
|
||||||
# Ref: https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-global-section
|
|
||||||
ARG RUNNER_LISTEN_ADDRESS="disabled"
|
|
||||||
ENV RUNNER_LISTEN_ADDRESS=$RUNNER_LISTEN_ADDRESS
|
|
||||||
RUN if [[ "$RUNNER_LISTEN_ADDRESS" == "disabled" ]]; then \
|
|
||||||
sed -i -r \
|
|
||||||
-e "s/.*@@RUNNER_LISTEN_ADDRESS@@.*//g" \
|
|
||||||
/home/podman/.gitlab-runner/config.toml; \
|
|
||||||
else \
|
|
||||||
sed -i -r \
|
|
||||||
-e "s/@@RUNNER_LISTEN_ADDRESS@@/$RUNNER_LISTEN_ADDRESS/g" \
|
|
||||||
/home/podman/.gitlab-runner/config.toml; \
|
|
||||||
fi
|
|
||||||
|
|
||||||
# A small wrapper is needed to launch a background podman system service
|
# Allow image-builders to choose an alternate nested-container pruning cycle.
|
||||||
# process for the gitlab-runner to connect to.
|
# For most people the default is probably fine. This setting is dependent
|
||||||
ADD /gitlab-runner-wrapper /podman-in-podman-maintenance /usr/local/bin/
|
# on the number and frequency of jobs run, along with the amount of disk-space
|
||||||
# Base image UTS NS configuration causes runner to break when launching
|
# available for both /cache and /home/podman/.local/share/containers volumes.
|
||||||
# nested rootless containers.
|
ARG PRUNE_INTERVAL=daily # see systemd.timer for allowable values
|
||||||
RUN sed -i -r \
|
|
||||||
-e 's/^utsns.+host.*/utsns="private"/' \
|
|
||||||
/etc/containers/containers.conf && \
|
|
||||||
chmod +x /usr/local/bin/gitlab-runner-wrapper && \
|
|
||||||
chmod +x /usr/local/bin/podman-in-podman-maintenance && \
|
|
||||||
chown -R podman.podman /home/podman && \
|
|
||||||
rm -f /home/podman/.bash* && \
|
|
||||||
echo DOCKER_HOST="unix:///tmp/podman-run-1000/podman/podman.sock" > /etc/profile.d/podman.sh && \
|
|
||||||
|
|
||||||
# Runtime rootless-mode configuration
|
# All-in-one packaging/image-setup script to keep things simple.
|
||||||
USER podman
|
RUN PRUNE_INTERVAL=${PRUNE_INTERVAL} \
|
||||||
VOLUME ["/home/podman/.local/share/containers/storage/",\
|
RUNNER_VERSION=${RUNNER_VERSION} \
|
||||||
"/home/podman/.gitlab-runner/"]
|
bash /root/setup.sh
|
||||||
WORKDIR /home/podman
|
|
||||||
ENTRYPOINT ["/usr/local/bin/gitlab-runner-wrapper"]
|
|
||||||
|
|
||||||
# Ensure root storage directory exists with correct permissions
|
VOLUME /cache /home/podman/.local/share/containers
|
||||||
RUN mkdir -p .local/share/containers/storage
|
ENTRYPOINT /lib/systemd/systemd
|
||||||
|
|
||||||
# Gitlab-runner configuration options. Default to unprivileged (nested)
|
# Gitlab-runner configuration options, may be freely overridden at
|
||||||
# runner. Privileged is required to permit nested container image building.
|
# container image build time.
|
||||||
ARG RUNNER_NAME="qontainers-pipglr"
|
ARG DEFAULT_JOB_IMAGE=registry.fedoraproject.org/fedora-minimal:latest
|
||||||
ARG PRIVILEGED_RUNNER="false"
|
# Allow image-builders to override the Gitlab URL
|
||||||
# Tags allow pinning jobs to specific runners, comma-separated list of
|
ARG GITLAB_URL=https://gitlab.com/
|
||||||
# tags to add to runner (no spaces!)
|
# Run nested containers in --privileged mode - required to allow building
|
||||||
ARG RUNNER_TAGS="podman-in-podman"
|
# container images using podman or buildah. Otherwise may be set 'false'.
|
||||||
# Permit running jobs without any tag at all
|
ARG NESTED_PRIVILEGED=true
|
||||||
ARG RUNNER_UNTAGGED="true"
|
|
||||||
ENV REGISTER_NON_INTERACTIVE="true" \
|
|
||||||
RUNNER_TAG_LIST="$RUNNER_TAGS" \
|
|
||||||
REGISTER_RUN_UNTAGGED="$RUNNER_UNTAGGED" \
|
|
||||||
REGISTER_ACCESS_LEVEL="ref_protected" \
|
|
||||||
REGISTER_MAXIMUM_TIMEOUT="3600" \
|
|
||||||
CI_SERVER_URL="https://gitlab.com/" \
|
|
||||||
RUNNER_NAME="${RUNNER_NAME}" \
|
|
||||||
RUNNER_EXECUTOR="docker" \
|
|
||||||
RUNNER_SHELL="bash" \
|
|
||||||
REGISTER_MAINTENANCE_NOTE="Podman-in-Podman containerized runner" \
|
|
||||||
DOCKER_HOST="unix:///tmp/podman-run-1000/podman/podman.sock" \
|
|
||||||
DOCKER_DEVICES="/dev/fuse" \
|
|
||||||
DOCKER_IMAGE="registry.fedoraproject.org/fedora-minimal:latest" \
|
|
||||||
DOCKER_CACHE_DIR="/home/podman/.cache/gitlab-runner" \
|
|
||||||
DOCKER_NETWORK_MODE="host" \
|
|
||||||
DOCKER_PRIVILEGED="$PRIVILEGED_RUNNER"
|
|
||||||
|
|
||||||
# Not a real build-arg. Simply here to save lots of typing.
|
# The registration runlabel may be called multiple times to register more than
|
||||||
ARG _pm="--systemd=true --device=/dev/fuse --security-opt label=disable --user podman --volume pipglr-podman-root:/home/podman/.local/share/containers/storage:Z --volume pipglr-runner-config:/home/podman/.gitlab-runner:Z -e PODMAN_RUNNER_DEBUG -e LOG_LEVEL"
|
# one runner. Each expects a REGISTRATION_TOKEN secret to be pre-defined and
|
||||||
|
# the file './config.toml' to exist (may be empty). A local-cache volume
|
||||||
# These labels simply make it easier to register and execute the runner.
|
# '/cache' is configured for bind-mounting into all interrior-containers
|
||||||
# Define them last so they are absent should a image-build failure occur.
|
# for container-runtime use, as recommended by the docs. Other settings
|
||||||
LABEL register="podman run -it --rm $_pm --secret REGISTRATION_TOKEN,type=env \$IMAGE register"
|
# may be changed if you know what you're doing.
|
||||||
# Note: Privileged mode is required to permit building container images with inner-podman
|
LABEL register="podman run -it --rm \
|
||||||
LABEL run="podman run -d --rm --privileged --name gitlab-runner $_pm \$IMAGE run"
|
--secret=REGISTRATION_TOKEN,type=env \
|
||||||
|
-v ./config.toml:/etc/gitlab-runner/config.toml:Z \
|
||||||
|
-e REGISTER_NON_INTERACTIVE=true \
|
||||||
|
-e CI_SERVER_URL=${GITLAB_URL} \
|
||||||
|
-e RUNNER_NAME=pipglr \
|
||||||
|
-e RUNNER_EXECUTOR=docker \
|
||||||
|
-e RUNNER_SHELL=bash \
|
||||||
|
-e DOCKER_HOST=unix:///home/runner/podman.sock \
|
||||||
|
-e DOCKER_IMAGE=${DEFAULT_JOB_IMAGE} \
|
||||||
|
-e DOCKER_CACHE_DIR=/cache \
|
||||||
|
-e DOCKER_VOLUMES=/cache \
|
||||||
|
-e DOCKER_NETWORK_MODE=host \
|
||||||
|
-e DOCKER_PRIVILEGED=${NESTED_PRIVILEGED} \
|
||||||
|
--entrypoint=/usr/bin/gitlab-runner \$IMAGE register"
|
||||||
|
# Additionally, the nested-podman storage volumes must be pre-created with
|
||||||
|
# 'podman' UID/GID values to allow nested containers access.
|
||||||
|
LABEL setupstorage="podman volume create --opt o=uid=1000,gid=1000 pipglr-storage"
|
||||||
|
# Lastly, the gitlab-runner will manage container-cache in this directory,
|
||||||
|
# which will also be bind-mounted into every container. So it must be
|
||||||
|
# writable by both 'podman' user and 'runner' group.
|
||||||
|
LABEL setupcache="podman volume create --opt o=uid=1000,gid=1001 pipglr-cache"
|
||||||
|
# Helper to extract the current configuration secret to allow editing.
|
||||||
|
LABEL dumpconfig="podman run -it --rm \
|
||||||
|
--secret config.toml --entrypoint=/bin/cat \
|
||||||
|
\$IMAGE /var/run/secrets/config.toml"
|
||||||
|
# Executing the runner container depends on the config.toml secret being
|
||||||
|
# set (see above) and two volumes existing with correct permissions set.
|
||||||
|
# Note: The contents of the volumes are not critical, they may be removed
|
||||||
|
# and re-created (see above) to quickly free-up disk space.
|
||||||
|
LABEL run="podman run -dt --name pipglr \
|
||||||
|
--secret config.toml,uid=1001,gid=1001 \
|
||||||
|
-v pipglr-storage:/home/podman/.local/share/containers \
|
||||||
|
-v pipglr-cache:/cache \
|
||||||
|
--systemd true --privileged \
|
||||||
|
--device /dev/fuse \$IMAGE"
|
||||||
|
|||||||
284
README.md
284
README.md
@@ -20,145 +20,241 @@ when running potentially arbitrary CI/CD code. Though, the ultimate
|
|||||||
responsibility still rests with the end-user to review the setup and
|
responsibility still rests with the end-user to review the setup and
|
||||||
configuration relative to their own security situation/environment.
|
configuration relative to their own security situation/environment.
|
||||||
|
|
||||||
|
**Note**: While this can run entirely under a regular user, it will require
|
||||||
|
root access for the first two setup steps (below).
|
||||||
|
|
||||||
### Operation
|
### Operation
|
||||||
|
|
||||||
This image supports `podman container runlabel`, or if your version
|
This image leverages the podman `runlabel` feature heavily. Several
|
||||||
lacks this feature, Several labels are set on the image to support
|
labels are set on the image to support easy registration and execution
|
||||||
easy registration and execution of a runner container using a special
|
of the runner container. While it's possible to use the container
|
||||||
bash command. See the examples below for more information.
|
with your own command-line, it's highly recommended to base them
|
||||||
|
off of one of the labels. See the examples below for more information.
|
||||||
|
|
||||||
#### Volume Ownership Bug
|
***Note:*** Some older versions of podman don't support the
|
||||||
|
`container runlabel` sub-command. If this is the case, you may simulate
|
||||||
Some versions of podman contain a bug where named volumes aren't owned
|
it with the following, substituting `<label>` with one of the predefined
|
||||||
by the namespaced user within a rootless container (i.e. in conjunction
|
values (i.e. `register`, `setupconfig`, etc.):
|
||||||
with the --user option). Since the `podman` user/group inside the `pipglr`
|
|
||||||
container is known, it's possible to manually set/reset ownership:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
VOLUME=pipglr-podman-root
|
$ IMAGE="registry.gitlab.com/qontainers/pipglr:latest"
|
||||||
podman volume create $VOLUME
|
$ eval $(podman inspect --format=json $IMAGE | jq -r .[].Labels.<label>)
|
||||||
cd $(podman unshare podman volume mount $VOLUME)
|
|
||||||
podman unshare chown 1000:1000
|
|
||||||
podman volume unmount $VOLUME
|
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Runner registration
|
#### Persistent containers (step 1)
|
||||||
|
|
||||||
Each time the registration command is run, a new runner is added into
|
By default on many distributions, regular users aren't permitted to leave
|
||||||
the configuration. If however, you simply need to update/modify the
|
background processes running after they log out. Since this is likely
|
||||||
configuration, please edit the `config.toml` file directly after mounting
|
desired for running the pipglr container long-term, `systemd` needs to be
|
||||||
(default) `pipglr-runner-config` (`/home/podman/.gitlab-runner/`) volume.
|
configured to override this policy. For this, you (`$USER`) will need
|
||||||
For modern versions of podman, registration can be performed with the
|
root access on the system.
|
||||||
following commands:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
IMAGE="=registry.gitlab.com/qontainers/pipglr:latest"
|
$ sudo loginctl enable-linger $USER
|
||||||
echo '<actual registration token>' | podman secret create REGISTRATION_TOKEN -
|
|
||||||
podman container runlabel $IMAGE register --secret REGISTRATION_TOKEN,type=env
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Where `<actual registration token>` is the value obtained from the "runners"
|
Side-effect: This will allow your user to persist other user-level systemd
|
||||||
settings page of a gitlab group or project.
|
services as well. For example `podman.socket` is handy to enable for
|
||||||
|
`podman remote` access. You could also [setup
|
||||||
|
quadlet](https://www.redhat.com/sysadmin/quadlet-podman) or a systemd unit
|
||||||
|
so pipglr starts up on system boot.
|
||||||
|
|
||||||
Note: Some versions of podman don't support the `container runlabel` sub-command.
|
#### Expanded user-namespace (step 2) ***This is probably important***
|
||||||
If this is the case, you may simulate it with the following command (in addition
|
|
||||||
to the other example commands above):
|
As an added protection/safety measure, pipglr excludes three UID/GIDs
|
||||||
|
from being used by job-level containers. One for `root`, another for
|
||||||
|
`runner` and a third for `podman`. However, some container images
|
||||||
|
you may want to use for jobs (mainly Debian/Ubuntu), assign one/more
|
||||||
|
essential users a high UID/GID value (like `65535`).
|
||||||
|
|
||||||
|
At the same time, most distributions also set `65536` as the default maximum
|
||||||
|
number (including ID `0`) of IDs to allocate for user-namespaces (via `/etc/login.defs`). This
|
||||||
|
creates a problem you won't realize until the runner actually picks up a job
|
||||||
|
😞 The main symptom of this issue will be messages in the pipglr containers log,
|
||||||
|
similar to (abbreviated):
|
||||||
|
|
||||||
|
```
|
||||||
|
...cut...
|
||||||
|
running `/usr/bin/newuidmap ...cut...`: newuidmap: write to uid_map failed: Operation not permitted
|
||||||
|
Error: cannot set up namespace using "/usr/bin/newuidmap": exit status 1
|
||||||
|
...cut...
|
||||||
|
```
|
||||||
|
|
||||||
|
or
|
||||||
|
|
||||||
|
```
|
||||||
|
E: setgroups 65534 failed - setgroups (22: Invalid argument)
|
||||||
|
```
|
||||||
|
|
||||||
|
***The good news is, working around this is relatively simple:***
|
||||||
|
|
||||||
|
As root, edit the two files `/etc/subuid` and `/etc/subgid` to expand the
|
||||||
|
by 3 IDs. For example assuming a user running the pipglr container is
|
||||||
|
called `johndoe`, the contents of these files should be edited to allocate
|
||||||
|
`65539` IDs like:
|
||||||
|
|
||||||
|
`jogndoe:<some number>:65539`
|
||||||
|
|
||||||
|
Where `<some number>` was set by your OS when the `johndoe` user was created
|
||||||
|
(you can ignore this). Only the last number needs to be increased. This
|
||||||
|
change will be effective on next login, or immediately by running:
|
||||||
|
|
||||||
|
`podman system migrate`
|
||||||
|
|
||||||
|
*Note:* This will stop any currently running containers.
|
||||||
|
|
||||||
|
#### Runner registration (step 3)
|
||||||
|
|
||||||
|
All runners must be connected to a project or group runner configuration
|
||||||
|
on your gitlab instance (or `gitlab.com`). This is done using a special
|
||||||
|
registration *runlabel*. The command can (and probably should) be run
|
||||||
|
more than once (using the same `config.toml`) to configure and register
|
||||||
|
multiple runners. This is necessary for the *pipglr* container to execute
|
||||||
|
multiple jobs in parallel. For example, if you want to support running
|
||||||
|
four jobs at the same time, you would use the `register` *runlabel*
|
||||||
|
four times.
|
||||||
|
|
||||||
|
Before using the `register` *runlabel*, you must set your unique
|
||||||
|
*registration* (a.k.a. *activation*) token as a podman *secret*. This
|
||||||
|
secret may be removed once the registration step is complete. The
|
||||||
|
**<actual registration token>** value (below) should be replaced with
|
||||||
|
the value obtained from the "runners" settings page of a gitlab
|
||||||
|
group or project's *CI/CD Settings*. Gitlab version 16 and later
|
||||||
|
refers to this value as an *activation* token, but the usage is the same.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
eval $(podman inspect --format=json $IMAGE | jq -r .[].Labels.register)
|
$ IMAGE="registry.gitlab.com/qontainers/pipglr:latest"
|
||||||
|
$ echo '<actual registration token>' | podman secret create REGISTRATION_TOKEN -
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Runner Startup
|
Next, ***a blank `config.toml` file*** needs to be created. Without this, the
|
||||||
|
`reigster` *runlabel* will return a permission-denied error. Once the empty
|
||||||
With one or more runners successfully registered and configured, the GitLab
|
`config.toml` file is created, you may register one or more runners by repeating
|
||||||
runner container may be launched with the following commands:
|
the registration *runlabel* as follows:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
podman container runlabel $IMAGE run
|
$ IMAGE="registry.gitlab.com/qontainers/pipglr:latest"
|
||||||
|
$ touch ./config.toml # important: file must exist, even if empty.
|
||||||
|
$ podman container runlabel register $IMAGE
|
||||||
|
...repeat as desired...
|
||||||
|
$ podman secret rm REGISTRATION_TOKEN # if desired
|
||||||
```
|
```
|
||||||
|
|
||||||
As above, if you're missing the `container runlabel` sub-command, the following
|
#### Runner Configuration (step 4)
|
||||||
may be used instead (assuming `$IMAGE` remains set):
|
|
||||||
|
During the registration process (above), a boiler-plate (default) `config.toml` file
|
||||||
|
will be created/updated for you. At this point you may edit the configuration
|
||||||
|
if desired before committing it as a *podman secret*. Please refer to the
|
||||||
|
[gitlab runner documentation](https://docs.gitlab.com/runner/configuration/)
|
||||||
|
for details.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ eval $(podman inspect --format=json $IMAGE | jq -r .[].Labels.run)
|
$ $EDITOR ./config.toml # if desired
|
||||||
|
$ podman secret create config.toml ./config.toml
|
||||||
|
$ rm ./config.toml # if desired
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Debugging
|
This may be necessary, for example, to increase the default `concurrency` value
|
||||||
|
to reflect the number of registered runners. If you need to edit this file
|
||||||
|
after committing it as a secret, there's
|
||||||
|
[ a `dumpconfig` *runlabel* for that](README.md#configuration-editing).
|
||||||
|
|
||||||
Before starting the runner, you may `export PODMAN_RUNNER_DEBUG=debug` to enable
|
#### Quadlet setup and container start (step 5)
|
||||||
debugging on the inner-podman. Whereas `export LOG_LEVEL=debug` can be used to
|
|
||||||
debug the gitlab-runner itself.
|
**Note**: If your system is missing or does not support the use of quadlet
|
||||||
|
(`man 5 podman-systemd.unit`), you'll find [manual volume setup steps
|
||||||
|
here](manual_setup.md).
|
||||||
|
|
||||||
|
Create and copy the quadlet configuration files:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ mkdir -p ~/.config/containers/systemd
|
||||||
|
$ cp quadlet/* ~/.config/containers/systemd/
|
||||||
|
```
|
||||||
|
|
||||||
|
Finally, reload the local systemd user-slice to generate the unit files,
|
||||||
|
and fire up pipglr!
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ systemd --user daemon-reload
|
||||||
|
$ systemd start pipglr
|
||||||
|
```
|
||||||
|
|
||||||
|
If you want the service to start automatically on boot, you may run
|
||||||
|
`systemctl --user enable podman-restart.service`
|
||||||
|
|
||||||
|
### Configuration Editing
|
||||||
|
|
||||||
|
The gitlab-runner configuration contains some sensitive values which
|
||||||
|
should be protected. The pipglr container assumes the entire configuration
|
||||||
|
will be passed in as a Podman secret. This makes editing it slightly
|
||||||
|
convoluted, so a handy *runlabel* `dumpconfig` is available.
|
||||||
|
It's intended use is as follows:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ IMAGE="registry.gitlab.com/qontainers/pipglr:latest"
|
||||||
|
$ podman container runlabel dumpconfig $IMAGE > ./config.toml
|
||||||
|
$ $EDITOR ./config.toml
|
||||||
|
$ podman secret rm config.toml
|
||||||
|
$ podman secret create config.toml ./config.toml
|
||||||
|
$ rm ./config.toml # if desired
|
||||||
|
```
|
||||||
|
|
||||||
|
### Debugging
|
||||||
|
|
||||||
|
The first thing to check is the container output. This shows three things:
|
||||||
|
Systemd, Podman, and GitLab-Runner output. For example:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ podman logs --since 0 pipglr
|
||||||
|
```
|
||||||
|
|
||||||
|
Next, try running a pipglr image built with more verbose logging. Both
|
||||||
|
the `runner.service` and `podman.service` files have a `log-level` option.
|
||||||
|
Simply increase one or both to the "info", or "debug" level. Start the
|
||||||
|
debug container, and reproduce the problem.
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
This image may be built simply with:
|
This image may be built simply with:
|
||||||
|
|
||||||
`podman build -t registry.gitlab.com/qontainers/pipglr:latest .`
|
```bash
|
||||||
|
$ podman build -t registry.gitlab.com/qontainers/pipglr:latest .
|
||||||
|
```
|
||||||
|
|
||||||
This will utilize the latest stable version of podman and the latest
|
This will utilize the latest stable version of podman and the latest
|
||||||
stable version of the gitlab runner.
|
stable version of the gitlab runner.
|
||||||
|
|
||||||
### Notes
|
|
||||||
|
|
||||||
* If you wish to use the `testing` or `upstream` flavors of the podman base image,
|
|
||||||
simply build with `--build-arg FLAVOR=testing` (or `upstream`).
|
|
||||||
|
|
||||||
* Additionally or alternatively, you may specify a specific podman base image tag
|
|
||||||
with `--build-arg BASE_TAG=<value>`. Where `<value>` is either `latest`, the
|
|
||||||
podman image version (e.g. `v4`, `v4.2`, `v4.2.0`, etc.)
|
|
||||||
|
|
||||||
### Build-args
|
### Build-args
|
||||||
|
|
||||||
Several build arguments are available to control the output image:
|
Several build arguments are available to control the output image:
|
||||||
|
|
||||||
* `FLAVOR` - Choose from 'stable', 'testing', or 'upstream'. These
|
* `PRUNE_INTERVAL` - A systemd.timer compatible `OnCalendar` value that
|
||||||
select the podman base-image to utilize - which may affect the
|
determines how often to prune Podman's storage of disused containers and
|
||||||
podman version, features, and stability. For more information
|
images. Defaults to "daily", but should be adjusted based on desired
|
||||||
see [the podmanimage README](https://github.com/containers/podman/blob/main/contrib/podmanimage/README.md).
|
caching-effect balanced against available storage space and job
|
||||||
* `BASE_TAG` - When `FLAVOR="stable"`, allows granular choice over the
|
execution rate.
|
||||||
exact podman version. Possible values include, `latest`, `vX`, `vX.Y`,
|
|
||||||
and `vX.Y.Z` (where, `X`, `Y`, and `Z` represent the podman semantic
|
|
||||||
version numbers). It's also possible to specify an image SHA.
|
|
||||||
* `EXCLUDE_PACKAGES` - A space-separated list of RPM packages to prevent
|
|
||||||
their existence in the final image. This is intended as a security measure
|
|
||||||
to limit the attack-surface should a gitlab-runner process escape it's
|
|
||||||
inner-container.
|
|
||||||
* `RUNNER_VERSION` - Allows specifying an exact gitlab runner version.
|
* `RUNNER_VERSION` - Allows specifying an exact gitlab runner version.
|
||||||
By default the `latest` is used, assuming the user is building a tagged
|
By default the `latest` is used, assuming the user is building a tagged
|
||||||
image anyway. Valid versions may be found on the [runner
|
image anyway. Valid versions may be found on the [runner
|
||||||
release page](https://gitlab.com/gitlab-org/gitlab-runner/-/releases).
|
release page](https://gitlab.com/gitlab-org/gitlab-runner/-/releases).
|
||||||
* `DNFCMD` - By default this is set to `dnf --setopt=tsflags=nodocs -y`.
|
|
||||||
However, if you'd like to volume-mount in `/var/cache/dnf` then you'll
|
|
||||||
need to use
|
|
||||||
`--build-arg DNFCMD="dnf --setopt=tsflags=nodocs -y --setopt keepcache=true`"
|
|
||||||
Note: Changing `DNFCMD` will cause build-time cache cleanup to be disabled.
|
|
||||||
* `TARGETARCH` - Supports inclusion of non-x86_64 gitlab runners. This
|
* `TARGETARCH` - Supports inclusion of non-x86_64 gitlab runners. This
|
||||||
value is assumed to match the image's architecture. If using the
|
value is assumed to match the image's architecture. If using the
|
||||||
`--platform` build argument, it will be set automatically.
|
`--platform` build argument, it will be set automatically. Note:
|
||||||
* `RUNNER_LISTEN_ADDRESS` - Disabled by default, setting this to the FQDN
|
as of this writing, only `amd64` and `arm64` builds of the gitlab-runner
|
||||||
and port supports various observability and debugging features of the
|
are available.
|
||||||
gitlab runner. For more information see the [gitlab runner advanced
|
* `GITLAB_URL` - Defaults to 'https://gitlab.com/' but can be set to point
|
||||||
configuration documentation](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-global-section).
|
to a self hosted instance of Gitlab.
|
||||||
* `PRIVILEGED_RUNNER` - Defaults to 'false', may be set 'true'. When
|
* `NESTED_PRIVILEGED` - Defaults to 'true', may be set 'false' to prevent
|
||||||
`true`, this causes inner-containers to be created with the `--privileged`
|
nested containers running in `--privileged` mode. This will affect
|
||||||
flag. This is a potential security weakness, but is necessary for
|
the ability to build container images in CI jobs using tools like
|
||||||
(among other things) allowing nested container image builds.
|
podman or buildah.
|
||||||
* `RUNNER_TAGS` - Defaults to `podman_in_podman`, may be set to any comma-separated
|
|
||||||
list (with no spaces!) of tags. These show up in GitLab (not the runner
|
|
||||||
configuration), and determines where jobs are run.
|
|
||||||
* `RUNNER_UNTAGED` - Defaults to `true`, may be set to `false`. Allows
|
|
||||||
the runner to service jobs without any tags on them at all.
|
|
||||||
|
|
||||||
### Environment variables
|
### Environment variables
|
||||||
|
|
||||||
Nearly every option to every gitlab-runner sub-command may be specified via
|
Nearly every option to every gitlab-runner sub-command may be specified via
|
||||||
environment variable. Many important/required options are set in the
|
environment variable. Some of these are set in the `Containerfile` for
|
||||||
`Containerfile`. However it's entirely possible to pass them in via
|
the `register` *runlabel*. If you need to set additional runtime
|
||||||
either of the `podman container runlabel...` container commands. To
|
env. vars., please do so via additional `Environment` optionns in the
|
||||||
discover them, simply append `--help` to the end of the command.
|
`runner.service` file. See the *systemd.nspawn* man page for important
|
||||||
For example:
|
value-format details.
|
||||||
|
|
||||||
```bash
|
|
||||||
podman container runlabel $IMAGE register --help
|
|
||||||
```
|
|
||||||
|
|||||||
@@ -1,7 +0,0 @@
|
|||||||
|
|
||||||
# Ref: https://docs.gitlab.com/runner/configuration/advanced-configuration.html
|
|
||||||
|
|
||||||
concurrent = 8
|
|
||||||
# N/B: This is DIVIDED among the number of registered runners
|
|
||||||
check_interval = 10
|
|
||||||
listen_address = "@@RUNNER_LISTEN_ADDRESS@@" # Will be removed if undefined
|
|
||||||
3
etc/systemd/system.conf.d/10-kmsglog.conf
Normal file
3
etc/systemd/system.conf.d/10-kmsglog.conf
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
[Manager]
|
||||||
|
LogTarget=kmsg
|
||||||
|
LogColor=yes
|
||||||
2
etc/systemd/system.conf.d/20-tasklimit.conf
Normal file
2
etc/systemd/system.conf.d/20-tasklimit.conf
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
[Manager]
|
||||||
|
DefaultTasksMax=infinity
|
||||||
2
etc/systemd/system/user-.slice.d/20-tasklimit.conf
Normal file
2
etc/systemd/system/user-.slice.d/20-tasklimit.conf
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
[Slice]
|
||||||
|
TasksMax=infinity
|
||||||
@@ -1,28 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
# This script is intended to be called as the entrypoint for
|
|
||||||
# a podman-in-podman gitlab runner container. Any usage
|
|
||||||
# outside that context is not supported and may cause harm.
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
unset _debug_args
|
|
||||||
if [[ -n "$PODMAN_RUNNER_DEBUG" ]]; then
|
|
||||||
_debug_args="--log-level=$PODMAN_RUNNER_DEBUG"
|
|
||||||
fi
|
|
||||||
|
|
||||||
SOCKET="/tmp/podman-run-1000/podman/podman.sock"
|
|
||||||
if [[ "$1" == "run" ]] && [[ ! -S "$SOCKET" ]]; then
|
|
||||||
podman $_debug_args system service -t 0 &
|
|
||||||
/usr/local/bin/podman-in-podman-maintenance &
|
|
||||||
# Prevent SIGHUP propagation to podman process
|
|
||||||
disown -ar
|
|
||||||
sleep 1s # Give podman a chance to get going
|
|
||||||
# Verify podman is listening on it's socket
|
|
||||||
if [[ ! -S "$SOCKET" ]]; then
|
|
||||||
echo "ERROR: Inner-podman system service failed to start, expecting to find socket '$SOCKET'. Are all volume's owned & writeable by $(id -u podman):$(id -g podman)?" > /dev/stderr
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
fi
|
|
||||||
|
|
||||||
exec gitlab-runner "$@"
|
|
||||||
13
home/podman/.config/containers/containers.conf
Normal file
13
home/podman/.config/containers/containers.conf
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
[containers]
|
||||||
|
netns="host"
|
||||||
|
userns="host"
|
||||||
|
ipcns="host"
|
||||||
|
utsns="private"
|
||||||
|
cgroupns="host"
|
||||||
|
cgroups="disabled"
|
||||||
|
log_driver = "k8s-file"
|
||||||
|
|
||||||
|
[engine]
|
||||||
|
cgroup_manager = "cgroupfs"
|
||||||
|
events_logger="file"
|
||||||
|
runtime="crun"
|
||||||
18
home/podman/.config/systemd/user/podman.service
Normal file
18
home/podman/.config/systemd/user/podman.service
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Podman API Service
|
||||||
|
Requires=podman.socket
|
||||||
|
After=podman.socket
|
||||||
|
Documentation=man:podman-system-service(1)
|
||||||
|
StartLimitIntervalSec=0
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Delegate=true
|
||||||
|
Type=exec
|
||||||
|
KillMode=process
|
||||||
|
Environment=LOGGING="--log-level=warn"
|
||||||
|
ExecStart=/usr/bin/podman $LOGGING system service
|
||||||
|
StandardOutput=journal+console
|
||||||
|
StandardError=inherit
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=default.target
|
||||||
11
home/podman/.config/systemd/user/podman.socket
Normal file
11
home/podman/.config/systemd/user/podman.socket
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Podman API Socket
|
||||||
|
Documentation=man:podman-system-service(1)
|
||||||
|
|
||||||
|
[Socket]
|
||||||
|
ListenStream=/home/runner/podman.sock
|
||||||
|
SocketGroup=runner
|
||||||
|
SocketMode=0660
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=sockets.target
|
||||||
6
home/podman/.config/systemd/user/prune.service
Normal file
6
home/podman/.config/systemd/user/prune.service
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Prune all disused podman volumes, images, and containers
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
ExecStart=/usr/bin/podman system prune --all --force
|
||||||
6
home/podman/.config/systemd/user/prune.timer
Normal file
6
home/podman/.config/systemd/user/prune.timer
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Execute the prune service periodically
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=@@@PRUNE_INTERVAL@@@
|
||||||
|
RemainAfterElapse=no
|
||||||
7
home/runner/.config/systemd/user/runner.service
Normal file
7
home/runner/.config/systemd/user/runner.service
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Gitlab-runner service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
ExecStart=/usr/bin/gitlab-runner --log-level=warn run --user runner --working-directory=/home/runner
|
||||||
|
StandardOutput=journal+console
|
||||||
|
StandardError=inherit
|
||||||
32
manual_setup.md
Normal file
32
manual_setup.md
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
### Additional Manual steps
|
||||||
|
|
||||||
|
On systems without Quadlet, some additional steps are required
|
||||||
|
to get the pipglr container up and running.
|
||||||
|
|
||||||
|
### Manual Volume setup
|
||||||
|
|
||||||
|
Since several users are utilized inside the container volumes must be
|
||||||
|
specifically configured to permit access. This is done using several
|
||||||
|
*runlabels* as follows:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ IMAGE="registry.gitlab.com/qontainers/pipglr:latest"
|
||||||
|
$ podman container runlabel setupstorage $IMAGE
|
||||||
|
$ podman container runlabel setupcache $IMAGE
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: These volumes generally do not contain any critical operational data,
|
||||||
|
they may be re-created anytime to quickly free up host disk-space if
|
||||||
|
it's running low. Simply remove them with the command
|
||||||
|
`podman volume rm pipglr-storage pipglr-cache`. Then reuse the `setupstorage`
|
||||||
|
and `setupcache` *runlabels* as in the above example.
|
||||||
|
|
||||||
|
#### Manual Runner Startup
|
||||||
|
|
||||||
|
With the runner configuration saved as a Podman secret, and the runner volumes
|
||||||
|
created, the GitLab runner container may be launched with the following commands:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ IMAGE="registry.gitlab.com/qontainers/pipglr:latest"
|
||||||
|
$ podman container runlabel run $IMAGE
|
||||||
|
```
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
# This script is intended to be called by the entrypoint for
|
|
||||||
# a podman-in-podman gitlab runner container. Any usage
|
|
||||||
# outside that context is not supported and may cause harm.
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
maintain_podman() {
|
|
||||||
# Two days seems to be a good happy-medium beween filling up
|
|
||||||
# about 40gig of storage space from moderate CI activity,
|
|
||||||
# and maintaining a useful level of caching.
|
|
||||||
while sleep 2d; do
|
|
||||||
if [[ -n "$PODMAN_RUNNER_DEBUG" ]]; then
|
|
||||||
echo "$(date --iso-8601=second) ${BASH_SOURCE[0] performing podman maintenance}"
|
|
||||||
fi
|
|
||||||
podman system prune --all --force
|
|
||||||
done
|
|
||||||
}
|
|
||||||
13
quadlet/pipglr-cache.volume
Normal file
13
quadlet/pipglr-cache.volume
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Podman-in-podman GitLab Runner job cache storage volume
|
||||||
|
Documentation=https://gitlab.com/qontainers/pipglr/-/blob/main/README.md
|
||||||
|
After=local-fs.target
|
||||||
|
Requires=podman.socket
|
||||||
|
|
||||||
|
[Volume]
|
||||||
|
VolumeName=pipglr-cache
|
||||||
|
Copy=false
|
||||||
|
# The `podman` user inside the container should own everything
|
||||||
|
Options=o=uid=1000,gid=1000
|
||||||
|
# Support podman...prune --filters=persistent!=true
|
||||||
|
Label=persistent=true
|
||||||
13
quadlet/pipglr-storage.volume
Normal file
13
quadlet/pipglr-storage.volume
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Podman-in-podman GitLab Runner nested-container storage volume
|
||||||
|
Documentation=https://gitlab.com/qontainers/pipglr/-/blob/main/README.md
|
||||||
|
After=local-fs.target
|
||||||
|
Requires=podman.socket
|
||||||
|
|
||||||
|
[Volume]
|
||||||
|
VolumeName=pipglr-storage
|
||||||
|
Copy=false
|
||||||
|
# The `podman` user inside the container should own everything
|
||||||
|
Options=o=uid=1000,gid=1000
|
||||||
|
# Support podman...prune --filters=persistent!=true
|
||||||
|
Label=persistent=true
|
||||||
33
quadlet/pipglr.container
Normal file
33
quadlet/pipglr.container
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Podman-in-podman GitLab Runner
|
||||||
|
Documentation=https://gitlab.com/qontainers/pipglr/-/blob/main/README.md
|
||||||
|
After=pipglr-storage-volume.service pipglr-cache-volume.service
|
||||||
|
Requires=podman.socket pipglr-storage-volume.service pipglr-cache-volume.service
|
||||||
|
|
||||||
|
[Container]
|
||||||
|
ContainerName=pipglr
|
||||||
|
Image=registry.gitlab.com/qontainers/pipglr
|
||||||
|
|
||||||
|
# Required to run containers inside a container and ensure
|
||||||
|
# container can be managed with podman-restart.service
|
||||||
|
# Note: See https://github.com/containers/podman/issues/20418
|
||||||
|
PodmanArgs=--privileged --restart=always
|
||||||
|
|
||||||
|
# A nested systemd is used to manage nested podman & gitlab runner services
|
||||||
|
Systemd=true
|
||||||
|
|
||||||
|
# Allow jobs access to utilize fuse-overlayfs, for example to build container images.
|
||||||
|
Device=/dev/fuse
|
||||||
|
|
||||||
|
# Must be owned by the gitlab-runner user
|
||||||
|
Secret config.toml,uid=1001,gid=1001
|
||||||
|
|
||||||
|
# Add network isolation from other containers
|
||||||
|
Network=pipglr.network
|
||||||
|
|
||||||
|
# Storage for nested container images and job cache
|
||||||
|
Volume=pipglr-storage:/home/podman/.local/share/containers
|
||||||
|
Volume=pipglr-cache:/cache
|
||||||
|
|
||||||
|
# No need to preserve this between runs
|
||||||
|
VolatileTmp=true
|
||||||
11
quadlet/pipglr.network
Normal file
11
quadlet/pipglr.network
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Podman-in-podman GitLab Runner dedicated network
|
||||||
|
Documentation=https://gitlab.com/qontainers/pipglr/-/blob/main/README.md
|
||||||
|
After=network-online.target
|
||||||
|
Requires=podman.socket network.target
|
||||||
|
|
||||||
|
[Network]
|
||||||
|
Driver=bridge
|
||||||
|
# The pipglr container never accesses other containers on/or the host
|
||||||
|
Options=isolate
|
||||||
|
DisableDNS=true
|
||||||
127
root/setup.sh
Normal file
127
root/setup.sh
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
|
||||||
|
# This script is intended to be run during container-image build. Any
|
||||||
|
# other usage outside this context is likely to cause harm.
|
||||||
|
#
|
||||||
|
# Setup script for rootless podman container image to run rootless GitLab Runner service.
|
||||||
|
# Copyright (C) 2023 Christopher C. Evich
|
||||||
|
#
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or
|
||||||
|
# (at your option) any later version.
|
||||||
|
#
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU Lesser General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU Lesser General Public License
|
||||||
|
# along with this program
|
||||||
|
|
||||||
|
set -eo pipefail
|
||||||
|
|
||||||
|
for varname in PRUNE_INTERVAL RUNNER_VERSION TARGETARCH; do
|
||||||
|
if [[ -z "${!varname}" ]]; then
|
||||||
|
echo "Error: \$$varname must be non-empty."
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
# Make image smaller by not installing docs.
|
||||||
|
DNF="dnf --setopt=tsflags=nodocs -y"
|
||||||
|
|
||||||
|
for rpm in $(egrep -v '^(# )+' < /root/xpackages.txt); do
|
||||||
|
x+="--exclude=$rpm ";
|
||||||
|
done
|
||||||
|
|
||||||
|
set -x # show what's happening to make debugging easier
|
||||||
|
|
||||||
|
# DNF itself or a dependence may need upgrading, take care of it first.
|
||||||
|
$DNF upgrade
|
||||||
|
|
||||||
|
$DNF $x install \
|
||||||
|
podman \
|
||||||
|
systemd
|
||||||
|
|
||||||
|
# Gitlab-runner package contains scriptlets which do not function properly inside a
|
||||||
|
# container-build environment where systemd is not active/running.
|
||||||
|
$DNF $x --setopt=tsflags=noscripts install \
|
||||||
|
https://gitlab-runner-downloads.s3.amazonaws.com/$RUNNER_VERSION/rpm/gitlab-runner_${TARGETARCH}.rpm
|
||||||
|
|
||||||
|
# Allow removing dnf, sudo, etc. packages. Also don't start unnecessary or broken
|
||||||
|
# systemd services, like anything kernel related or login gettys.
|
||||||
|
rm -rf \
|
||||||
|
/etc/dnf/protected.d/* \
|
||||||
|
/etc/sytemd/system/getty.target.wants/* \
|
||||||
|
/etc/sytemd/system/multi-user.target.wants/* \
|
||||||
|
/etc/sytemd/system/sysinit.target.wants/* \
|
||||||
|
/etc/sytemd/system/timers.target.wants/* \
|
||||||
|
/lib/systemd/system/graphical.target.wants/* \
|
||||||
|
/lib/systemd/system/multi-user.target.wants/{getty.target,systemd-ask-password-wall.path} \
|
||||||
|
/lib/systemd/system/sys-kernel*.mount
|
||||||
|
|
||||||
|
# Remove unnecessary packages, see xpackages.txt to learn how this list was generated.
|
||||||
|
# This makes the image smaller and reduces the attack-surface.
|
||||||
|
dnf remove -y $(egrep -v '^(# )+' /root/xpackages.txt)
|
||||||
|
|
||||||
|
# Wipe out the DNF cache, then remove it entirely, again to make the image smaller.
|
||||||
|
$DNF clean all
|
||||||
|
rm -rf /var/cache/dnf /var/log/dnf* /var/log/yum.*
|
||||||
|
rpm -e dnf
|
||||||
|
|
||||||
|
# Workaround https://bugzilla.redhat.com/show_bug.cgi?id=1995337
|
||||||
|
rpm --setcaps shadow-utils
|
||||||
|
|
||||||
|
# Prevent copying of skel since it can interfere with the gitlab-runner
|
||||||
|
mkdir -p /home/podman /home/runner
|
||||||
|
# Guarantee uid/gid 1000 for user 'podman' / 1001 for user 'runner'.
|
||||||
|
groupadd -g 1000 podman
|
||||||
|
groupadd -g 1001 runner
|
||||||
|
# Separate users for services to increase process isolation.
|
||||||
|
# The 'podman' user's socket service writes /home/runner/podman.socket
|
||||||
|
useradd -M -u 1000 -g podman -G runner podman
|
||||||
|
useradd -M -u 1001 -g runner runner
|
||||||
|
# Allow 'podman' user to create socket file under /home/runner.
|
||||||
|
chmod 770 /home/runner
|
||||||
|
|
||||||
|
# Overwrite defaults, only user 'podman' permited to have a user-namespace
|
||||||
|
# Split the namespaced ID's around the containers root (ID 0), podman (ID 1000), and
|
||||||
|
# runner (ID 1001) such that the user-namespace of any nested containers cannot
|
||||||
|
# read or write any files owned by these users (and/or hijack nested container processes).
|
||||||
|
# N/B: The range-end (999+64536) ensures a total of 65535 IDs are available for nested-containers.
|
||||||
|
# This requires the host provide a sufficiently large range, i.e. `pipglr:<start>:65539`
|
||||||
|
echo -e "podman:1:999\npodman:1002:64536" | tee /etc/subuid > /etc/subgid
|
||||||
|
# Host volume mount necessary for nested-podman to use overlayfs2 for container & volume storage.
|
||||||
|
mkdir -p /home/podman/.local/share/containers
|
||||||
|
# Nested-container's local container-cache volume mount, recommended by gitlab-runner docs.
|
||||||
|
mkdir -p /cache
|
||||||
|
# Both the gitlab-runner and podman need access to the cache directory / volume mount.
|
||||||
|
chown podman:runner /cache
|
||||||
|
|
||||||
|
# Setup persistent 'podman' user services to start & run without a login.
|
||||||
|
mkdir -p /var/lib/systemd/linger
|
||||||
|
touch /var/lib/systemd/linger/podman
|
||||||
|
# Setup 'podman' socket and a container-storage pruning service for 'podman' user.
|
||||||
|
mkdir -p /home/podman/.config/systemd/user/{sockets.target.wants,default.target.wants}
|
||||||
|
cd /home/podman/.config/systemd/user/
|
||||||
|
ln -s $PWD/podman.socket ./sockets.target.wants/ # Added from Containerfile
|
||||||
|
ln -s $PWD/prune.timer ./default.target.wants/ # also from Containerfile
|
||||||
|
# Substitute value from --build-arg if specified, otherwise use default from Containerfile.
|
||||||
|
sed -i -e "s/@@@PRUNE_INTERVAL@@@/$PRUNE_INTERVAL/" ./prune.timer
|
||||||
|
# Containerfile ADD instruction does not properly set ownership/permissions.
|
||||||
|
chown -R 1000:1000 /home/podman
|
||||||
|
chmod 700 /home/podman
|
||||||
|
|
||||||
|
# Setup persistent 'runner' user services to start & run without a login.
|
||||||
|
touch /var/lib/systemd/linger/runner
|
||||||
|
mkdir -p /home/runner/.config/systemd/user/default.target.wants
|
||||||
|
cd /home/runner/.config/systemd/user/
|
||||||
|
# Does not depend on podman.socket file availablility, will retry if not present.
|
||||||
|
ln -s $PWD/runner.service ./default.target.wants/
|
||||||
|
# gitlab-runner will create side-car '.runner_system_id' file next to 'config.toml'
|
||||||
|
# on first startup. Ensure access is allowed. Also link to future config file
|
||||||
|
# presented as a container-secret.
|
||||||
|
mkdir -p /home/runner/.gitlab-runner
|
||||||
|
ln -s /var/run/secrets/config.toml /home/runner/.gitlab-runner/config.toml
|
||||||
|
# Containerfile ADD instruction does not properly set ownership/permissions.
|
||||||
|
chown -R runner:runner /home/runner
|
||||||
|
chmod -R 700 /home/runner/.gitlab-runner
|
||||||
21
root/xpackages.txt
Normal file
21
root/xpackages.txt
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# This list was formed by running the following commands in the base image:
|
||||||
|
# for package in $(rpm -qa); do if dnf erase $package; then echo "$package" >> remove; fi; done
|
||||||
|
# cat remove
|
||||||
|
# Including those packages in this file. Finally, repeatedly running the container build
|
||||||
|
# untill no dependency errors were raised.
|
||||||
|
|
||||||
|
criu
|
||||||
|
criu-libs
|
||||||
|
crypto-policies-scripts
|
||||||
|
dejavu-sans-fonts
|
||||||
|
findutils
|
||||||
|
fonts-filesystem
|
||||||
|
gdb-gdbserver
|
||||||
|
langpacks-core-en
|
||||||
|
langpacks-core-font-en
|
||||||
|
langpacks-en
|
||||||
|
libnet
|
||||||
|
protobuf-c
|
||||||
|
rootfiles
|
||||||
|
vim-minimal
|
||||||
|
yum
|
||||||
Reference in New Issue
Block a user