-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add kubeflow pipelines driver rock image (#159)
* Added rockcraft.yaml * Added sanity tests * Added tox.ini
- Loading branch information
Showing
3 changed files
with
176 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# Based on: https://github.com/kubeflow/pipelines/blob/2.2.0/backend/Dockerfile.driver | ||
name: kfp-driver | ||
summary: Kubeflow Pipelines Driver | ||
description: This image is used as part of the Charmed Kubeflow product | ||
version: 2.2.0 | ||
license: Apache-2.0 | ||
base: ubuntu@22.04 | ||
run-user: _daemon_ | ||
platforms: | ||
amd64: | ||
|
||
services: | ||
launcher: | ||
override: merge | ||
summary: "kfp driver service" | ||
startup: enabled | ||
user: appuser | ||
command: "/bin/driver" | ||
|
||
parts: | ||
security-team-requirement: | ||
plugin: nil | ||
override-build: | | ||
mkdir -p ${CRAFT_PART_INSTALL}/usr/share/rocks | ||
(echo "# os-release" && cat /etc/os-release && echo "# dpkg-query" && \ | ||
dpkg-query -f '${db:Status-Abbrev},${binary:Package},${Version},${source:Package},${Source:Version}\n' -W) > \ | ||
${CRAFT_PART_INSTALL}/usr/share/rocks/dpkg.query | ||
driver: | ||
plugin: go | ||
source-type: git | ||
source: https://github.com/kubeflow/pipelines.git | ||
source-depth: 1 | ||
source-tag: 2.2.0 | ||
build-snaps: | ||
- go/1.21/stable | ||
build-packages: | ||
- apt | ||
- bash | ||
build-environment: | ||
- CGO_ENABLED: 0 | ||
- GOOS: linux | ||
- GOARCH: amd64 | ||
stage-packages: | ||
- bash | ||
override-build: | | ||
set -xe | ||
mkdir -p $CRAFT_PART_INSTALL/bin | ||
mkdir -p $CRAFT_PART_INSTALL/third_party | ||
go build -tags netgo -ldflags '-extldflags "-static"' -o $CRAFT_PART_INSTALL/bin/driver $CRAFT_PART_BUILD/backend/src/v2/cmd/driver/*.go | ||
./hack/install-go-licenses.sh | ||
$GOBIN/go-licenses check $CRAFT_PART_BUILD/backend/src/v2/cmd/driver | ||
$GOBIN/go-licenses csv $CRAFT_PART_BUILD/backend/src/v2/cmd/driver > $CRAFT_PART_INSTALL/third_party/licenses.csv && \ | ||
diff $CRAFT_PART_INSTALL/third_party/licenses.csv $CRAFT_PART_BUILD/backend/third_party_licenses/driver.csv && \ | ||
$GOBIN/go-licenses save $CRAFT_PART_BUILD/backend/src/v2/cmd/driver --save_path $CRAFT_PART_INSTALL/third_party/NOTICES | ||
# not-root user for this rock should be 'appuser' | ||
non-root-user: | ||
plugin: nil | ||
after: [ driver ] | ||
overlay-script: | | ||
# Create a user in the $CRAFT_OVERLAY chroot | ||
groupadd -R $CRAFT_OVERLAY -g 1001 appuser | ||
useradd -R $CRAFT_OVERLAY -M -r -u 1001 -g appuser appuser | ||
override-prime: | | ||
craftctl default | ||
chown -R 584792:users bin | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Copyright 2024 Canonical Ltd. | ||
# See LICENSE file for licensing details. | ||
|
||
import pytest | ||
import subprocess | ||
|
||
from charmed_kubeflow_chisme.rock import CheckRock | ||
|
||
|
||
@pytest.mark.abort_on_fail | ||
def test_rock(): | ||
"""Test rock.""" | ||
check_rock = CheckRock("rockcraft.yaml") | ||
rock_image = check_rock.get_name() | ||
rock_version = check_rock.get_version() | ||
LOCAL_ROCK_IMAGE = f"{rock_image}:{rock_version}" | ||
|
||
# assert the rock contains the expected files | ||
subprocess.run( | ||
[ | ||
"docker", | ||
"run", | ||
"--rm", | ||
LOCAL_ROCK_IMAGE, | ||
"exec", | ||
"ls", | ||
"-la", | ||
"/third_party/licenses.csv", | ||
], | ||
check=True, | ||
) | ||
|
||
# Assert the rock contains the expected file in /third_party | ||
subprocess.run( | ||
[ | ||
"docker", | ||
"run", | ||
"--rm", | ||
LOCAL_ROCK_IMAGE, | ||
"exec", | ||
"ls", | ||
"-la", | ||
"/third_party/NOTICES/", | ||
], | ||
check=True, | ||
) | ||
|
||
subprocess.run( | ||
["docker", "run", "--rm", LOCAL_ROCK_IMAGE, "exec", "ls", "-la", "/bin/driver"], | ||
check=True, | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Copyright 2022 Canonical Ltd. | ||
# See LICENSE file for licensing details. | ||
[tox] | ||
skipsdist = True | ||
skip_missing_interpreters = True | ||
envlist = pack, export-to-docker, unit, sanity, integration | ||
|
||
[testenv] | ||
setenv = | ||
PYTHONPATH={toxinidir} | ||
PYTHONBREAKPOINT=ipdb.set_trace | ||
CHARM_REPO=https://github.com/canonical/kfp-operators.git | ||
CHARM_BRANCH=main | ||
LOCAL_CHARM_DIR=charm_repo | ||
|
||
[testenv:pack] | ||
passenv = * | ||
allowlist_externals = | ||
rockcraft | ||
commands = | ||
rockcraft pack | ||
|
||
[testenv:export-to-docker] | ||
passenv = * | ||
allowlist_externals = | ||
bash | ||
skopeo | ||
yq | ||
commands = | ||
# export to docker | ||
bash -c 'NAME=$(yq eval .name rockcraft.yaml) && \ | ||
VERSION=$(yq eval .version rockcraft.yaml) && \ | ||
ARCH=$(yq eval ".platforms | keys | .[0]" rockcraft.yaml) && \ | ||
ROCK="$\{NAME\}_$\{VERSION\}_$\{ARCH\}.rock" && \ | ||
DOCKER_IMAGE=$NAME:$VERSION && \ | ||
echo "Exporting $ROCK to docker as $DOCKER_IMAGE" && \ | ||
skopeo --insecure-policy copy oci-archive:$ROCK docker-daemon:$DOCKER_IMAGE' | ||
|
||
[testenv:sanity] | ||
passenv = * | ||
deps = | ||
pytest | ||
charmed-kubeflow-chisme | ||
commands = | ||
pytest -s -v --tb native --show-capture=all --log-cli-level=INFO {posargs} {toxinidir}/tests | ||
|
||
[testenv:integration] | ||
passenv = * | ||
allowlist_externals = | ||
echo | ||
commands = | ||
# TODO: Implement integration tests here | ||
echo "WARNING: This is a placeholder test - no test is implemented here." |