Skip to content

oscontainer beautification and checking #655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 24, 2019
Merged

oscontainer beautification and checking #655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8540a9
src/oscontainer.py: flake8 fixes
ashcrow Jul 24, 2019
d7f2388
Makefile: Enable check for oscontainer.py
ashcrow Jul 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ check: ${src_checked} ${tests_checked} ${cwd_checked} flake8
echo OK

flake8:
python3 -m flake8 --ignore=$(PYIGNORE) src/cosalib
python3 -m flake8 --ignore=$(PYIGNORE) src/cosalib src/oscontainer.py
# The following lines will verify python files that are not modules
# but are commented out as the files are not ready for checking yet
# grep -r "^\#\!/usr/bin/py" src/ | cut -d : -f 1 | xargs flake8 --ignore=$(PYIGNORE)
Expand Down
178 changes: 109 additions & 69 deletions src/oscontainer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,42 @@
# This command manipulates those images.

import gi

gi.require_version('OSTree', '1.0')

from gi.repository import GLib, Gio, OSTree
import os,sys,json,shutil,argparse,subprocess,re,collections
import tempfile,hashlib,gzip

import argparse
import json
import os
import shutil
import subprocess


OSCONTAINER_COMMIT_LABEL = 'com.coreos.ostree-commit'


def run_get_json(args):
return json.loads(subprocess.check_output(args))


def run_get_string(args):
return subprocess.check_output(args, encoding='UTF-8').strip()


def run_verbose(args, **kwargs):
print("+ {}".format(subprocess.list2cmdline(args)))
subprocess.check_call(args, **kwargs)


# Given a container reference, pull the latest version, then extract the ostree
# repo a new directory dest/repo.
def oscontainer_extract(containers_storage, src, dest,
tls_verify=True, ref=None, cert_dir="",
authfile=""):
dest = os.path.realpath(dest)
subprocess.check_call(["ostree", "--repo="+dest, "refs"])
rootarg = '--root='+containers_storage
subprocess.check_call(["ostree", "--repo=" + dest, "refs"])
rootarg = '--root=' + containers_storage
podCmd = ['podman', rootarg, 'pull']

if not tls_verify:
Expand All @@ -52,26 +63,30 @@ def oscontainer_extract(containers_storage, src, dest,
inspect = run_get_json(['podman', rootarg, 'inspect', src])[0]
commit = inspect['Labels'].get(OSCONTAINER_COMMIT_LABEL)
if commit is None:
raise SystemExit("Failed to find label '{}'".format(OSCONTAINER_COMMIT_LABEL))
raise SystemExit(
"Failed to find label '{}'".format(OSCONTAINER_COMMIT_LABEL))
iid = inspect['Id']
print("Preparing to extract cid: {}".format(iid))
# We're not actually going to run the container. The main thing `create` does
# then for us is "materialize" the merged rootfs, so we can mount it.
# We're not actually going to run the container. The main thing `create`
# does then for us is "materialize" the merged rootfs, so we can mount it.
# In theory we shouldn't need --entrypoint=/enoent here, but
# it works around a podman bug.
cid = run_get_string(['podman', rootarg, 'create', '--entrypoint=/enoent', iid])
cid = run_get_string([
'podman', rootarg, 'create', '--entrypoint=/enoent', iid])
mnt = run_get_string(['podman', rootarg, 'mount', cid])
try:
src_repo = os.path.join(mnt, 'srv/repo')
run_verbose(["ostree", "--repo="+dest, "pull-local", src_repo, commit])
run_verbose([
"ostree", "--repo=" + dest, "pull-local", src_repo, commit])
finally:
subprocess.call(['podman', rootarg, 'umount', cid])
if args.ref is not None:
run_verbose(["ostree", "--repo="+dest, "refs", '--create='+args.ref, commit])
if ref is not None:
run_verbose([
"ostree", "--repo=" + dest, "refs", '--create=' + ref, commit])


# Given an OSTree repository at src (and exactly one ref) generate an oscontainer
# with it.
# Given an OSTree repository at src (and exactly one ref) generate an
# oscontainer with it.
def oscontainer_build(containers_storage, src, ref, image_name_and_tag,
base_image, push=False, tls_verify=True, cert_dir="",
authfile="", inspect_out=None):
Expand All @@ -83,36 +98,41 @@ def oscontainer_build(containers_storage, src, ref, image_name_and_tag,
print("Resolved {} = {}".format(ref, rev))
[_, ostree_commit, _] = r.load_commit(rev)
ostree_commitmeta = ostree_commit.get_child_value(0)
versionv = ostree_commitmeta.lookup_value("version", GLib.VariantType.new("s"))
versionv = ostree_commitmeta.lookup_value(
"version", GLib.VariantType.new("s"))
if versionv:
ostree_version = versionv.get_string()
else:
ostree_version = None

rootarg = '--root='+containers_storage
rootarg = '--root=' + containers_storage
bid = run_get_string(['buildah', rootarg, 'from', base_image])
mnt = run_get_string(['buildah', rootarg, 'mount', bid])
try:
dest_repo = os.path.join(mnt, 'srv/repo')
subprocess.check_call(['mkdir', '-p', dest_repo])
subprocess.check_call(["ostree", "--repo="+dest_repo, "init", "--mode=archive"])
subprocess.check_call([
"ostree", "--repo=" + dest_repo, "init", "--mode=archive"])
# Note that oscontainers don't have refs
print("Copying ostree commit into container: {} ...".format(rev))
run_verbose(["ostree", "--repo="+dest_repo, "pull-local", src, rev])
run_verbose(["ostree", "--repo=" + dest_repo, "pull-local", src, rev])

# We use /noentry to trick `podman create` into not erroring out
# on a container with no cmd/entrypoint. It won't actually be run.
config=['--entrypoint', '["/noentry"]',
'-l', OSCONTAINER_COMMIT_LABEL+'='+rev]
config = ['--entrypoint', '["/noentry"]',
'-l', OSCONTAINER_COMMIT_LABEL + '=' + rev]
if ostree_version is not None:
config += ['-l', 'version='+ostree_version]
config += ['-l', 'version=' + ostree_version]
run_verbose(['buildah', rootarg, 'config'] + config + [bid])
print("Committing container...")
iid = run_get_string(['buildah', rootarg, 'commit', bid, image_name_and_tag])
iid = run_get_string([
'buildah', rootarg, 'commit', bid, image_name_and_tag])
print("{} {}".format(image_name_and_tag, iid))
finally:
subprocess.call(['buildah', rootarg, 'umount', bid], stdout=subprocess.DEVNULL)
subprocess.call(['buildah', rootarg, 'rm', bid], stdout=subprocess.DEVNULL)
subprocess.call([
'buildah', rootarg, 'umount', bid], stdout=subprocess.DEVNULL)
subprocess.call([
'buildah', rootarg, 'rm', bid], stdout=subprocess.DEVNULL)

if push:
print("Pushing container")
Expand All @@ -136,55 +156,75 @@ def oscontainer_build(containers_storage, src, ref, image_name_and_tag,
if authfile != "":
skopeoCmd.append("--authfile={}".format(authfile))

skopeoCmd.append("docker://"+image_name_and_tag)
skopeoCmd.append("docker://" + image_name_and_tag)
inspect = run_get_json(skopeoCmd)
else:
inspect = run_get_json(['podman', rootarg, 'inspect', image_name_and_tag])[0]
inspect = run_get_json([
'podman', rootarg, 'inspect', image_name_and_tag])[0]
if inspect_out is not None:
with open(inspect_out, 'w') as f:
json.dump(inspect, f)

# Parse args and dispatch
parser = argparse.ArgumentParser()
parser.add_argument("--workdir", help="Temporary working directory",
required=True)
parser.add_argument("--disable-tls-verify", help="Disable TLS for pushes and pulls",
action="store_true")
parser.add_argument("--cert-dir", help="Extra certificate directories",
default=os.environ.get("OSCONTAINER_CERT_DIR", ''))
parser.add_argument("--authfile", help="Path to authentication file",
action="store", default=os.environ.get("REGISTRY_AUTH_FILE", ''))
subparsers = parser.add_subparsers(dest='action')
parser_extract = subparsers.add_parser('extract', help='Extract an oscontainer')
parser_extract.add_argument("src", help="Image reference")
parser_extract.add_argument("dest", help="Destination directory")
parser_extract.add_argument("--ref", help="Also set an ostree ref")
parser_build = subparsers.add_parser('build', help='Build an oscontainer')
parser_build.add_argument("--from", help="Base image (default 'scratch')", default='scratch')
parser_build.add_argument("src", help="OSTree repository")
parser_build.add_argument("rev", help="OSTree ref (or revision)")
parser_build.add_argument("name", help="Image name")
parser_build.add_argument("--inspect-out", help="Write image JSON to file",
action='store', metavar='FILE')
parser_build.add_argument("--push", help="Push to registry",
action='store_true')
args = parser.parse_args()

containers_storage = os.path.join(args.workdir, 'containers-storage')
if os.path.exists(containers_storage):
shutil.rmtree(containers_storage)

if args.action == 'extract':
oscontainer_extract(containers_storage, args.src, args.dest,
tls_verify=not args.disable_tls_verify,
cert_dir=args.cert_dir,
ref=args.ref,
authfile=args.authfile)
elif args.action == 'build':
oscontainer_build(containers_storage, args.src, args.rev, args.name,
getattr(args, 'from'),
inspect_out=args.inspect_out,
push=args.push,
tls_verify=not args.disable_tls_verify,
cert_dir=args.cert_dir,
authfile=args.authfile)

def main():
# Parse args and dispatch
parser = argparse.ArgumentParser()
parser.add_argument("--workdir", help="Temporary working directory",
required=True)
parser.add_argument("--disable-tls-verify",
help="Disable TLS for pushes and pulls",
action="store_true")
parser.add_argument("--cert-dir", help="Extra certificate directories",
default=os.environ.get("OSCONTAINER_CERT_DIR", ''))
parser.add_argument("--authfile", help="Path to authentication file",
action="store",
default=os.environ.get("REGISTRY_AUTH_FILE", ''))
subparsers = parser.add_subparsers(dest='action')
parser_extract = subparsers.add_parser(
'extract', help='Extract an oscontainer')
parser_extract.add_argument("src", help="Image reference")
parser_extract.add_argument("dest", help="Destination directory")
parser_extract.add_argument("--ref", help="Also set an ostree ref")
parser_build = subparsers.add_parser('build', help='Build an oscontainer')
parser_build.add_argument(
"--from",
help="Base image (default 'scratch')",
default='scratch')
parser_build.add_argument("src", help="OSTree repository")
parser_build.add_argument("rev", help="OSTree ref (or revision)")
parser_build.add_argument("name", help="Image name")
parser_build.add_argument(
"--inspect-out",
help="Write image JSON to file",
action='store',
metavar='FILE')
parser_build.add_argument(
"--push",
help="Push to registry",
action='store_true')
args = parser.parse_args()

containers_storage = os.path.join(args.workdir, 'containers-storage')
if os.path.exists(containers_storage):
shutil.rmtree(containers_storage)

if args.action == 'extract':
oscontainer_extract(
containers_storage, args.src, args.dest,
tls_verify=not args.disable_tls_verify,
cert_dir=args.cert_dir,
ref=args.ref,
authfile=args.authfile)
elif args.action == 'build':
oscontainer_build(
containers_storage, args.src, args.rev, args.name,
getattr(args, 'from'),
inspect_out=args.inspect_out,
push=args.push,
tls_verify=not args.disable_tls_verify,
cert_dir=args.cert_dir,
authfile=args.authfile)


if __name__ == '__main__':
main()